Partners

Provision a partner-linked AgentTax account

Creates a linked AgentTax account on behalf of a partner-tenant user and returns a scoped API key. Idempotent on (partner_id, external_id) — repeat calls return the existing account without rotating credentials.

Auth: Partner provisioning key (ptx_live_…) sent as X-API-Key or Authorization: Bearer.

Rate limit: 600/min per partner key.

post/api/v1/partner/provision

Request

  • Base URL: https://www.agenttax.io
  • URL: https://www.agenttax.io/api/v1/partner/provision
  • Auth: API key in header X-API-Key

Request body

external_idstring required

Partner-side stable identifier for the user. Idempotency key — repeat calls with the same external_id return the existing account without rotating credentials.

emailstring email
display_namestring

Example request

{
  "external_id": "invoica_user_42",
  "email": "user@example.com"
}

Response

Account already provisioned. api_key and claim_url are NOT returned — those are first-call only.

agenttax_account_idstring required
partner_user_idstring required
api_keystring

Returned ONLY on first provision (HTTP 201). Subsequent calls with the same external_id return 200 without api_key. Store securely — cannot be retrieved later, only rotated.

claim_urlstring uri

User-facing claim link. Allows the end-user to take over the account directly with AgentTax. Returned only on first provision.

claim_expires_atstring date-time
already_provisionedboolean required

true on repeat calls (HTTP 200), false on first provision (HTTP 201).

claimedboolean

true if the user has claimed the account directly with AgentTax.

Example response

{
  "claim_expires_at": "2026-04-01T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.