Skip to main content

Exchange an enrolment code for the agent's connector-scoped key

POST 
/api/v1/connectors/agents/enrol

Unauthenticated: the code is the credential. A wrong, used or expired code is one answer, 404 ENROLMENT_CODE_INVALID. Rate-limited per address (20 in 10 minutes) and per code (5 in 15 minutes): 429 ENROLMENT_RATE_LIMITED. The key returned carries the agent scope: invoices create/send/read, transactions read and connectors:agent; never settings or connector management. The connector becomes active and the agent's registration is kept in config.agent; any earlier agent key of the connector is revoked.

Request​

Responses​

Successful Response