Create beneficiary
Beneficiary created with `status: pending`. Transitions to `active` after async
compliance validation. Poll until `active` before use.
Idempotency: **`Idempotency-Key` header recommended** (UUIDv4, persisted before
the request, reused on retries). Omitting it is permitted — the caller accepts all retry and duplicate risk.
Authentication
AuthorizationBearer
Token obtained via the login flow.
Headers
Idempotency-Key
Optional client-generated UUIDv4. Persist before issuing the request and reuse on retries. Omitting it is permitted — the caller accepts all retry and duplicate risk.
Request
This endpoint expects an object.
name
Legal name. ≤ 140 chars.
entityType
Allowed values:
address
currency
ISO 4217.
accountDetails
routingDetails
Response
Beneficiary created with status: pending. Transitions to active after async compliance validation. Poll until active before use.
beneficiaryId
status
Poll until active before referencing in a withdrawal.
Allowed values:
currency
One currency per beneficiary.
name
Legal name.
entityType
Allowed values:
accountDetails
routingDetails
createdAt
statusReason
Allowed values:
address
activatedAt
Errors
400
Bad Request Error
401
Unauthorized Error