Integration checklist
From the first test key to going live.
- 1. Get a
testkey with the right scope. Registering companies/certificates requiresfull_access; aninvoices_read_writekey can issue once the registration exists. - 2. Register or fetch the company in the corresponding environment (
POST /v1/companies,GET /v1/companies/:id). - 3. In
live, upload a valid A1 certificate matching the CNPJ (POST /v1/companies/:companyId/certificates). The municipal registration is optional. - 4. Check readiness with
GET /v1/companies/:id—statusmust bereadyandsetupGapsempty. - 5. Issue the first invoices in
testwith a stableIdempotency-Keyand storedata.id. - 6. Register a webhook (
POST /v1/webhooks) and confirm delivery withPOST /v1/webhooks/:id/test. - 7. Track status via
GET /v1/invoices/:idor signed webhooks; generate download URLs and request email only after documents are ready — checkemailStatusseparately.