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-KeystringOptionalformat: "uuid"

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.
namestringRequired<=140 characters

Legal name. ≤ 140 chars.

entityTypeenumRequired
addressobjectRequired
currencystringRequired
ISO 4217.
accountDetailslist of objectsRequired
routingDetailslist of objectsRequired

Response

Beneficiary created with status: pending. Transitions to active after async compliance validation. Poll until active before use.

beneficiaryIdstring
statusenum

Poll until active before referencing in a withdrawal.

currencystring
One currency per beneficiary.
namestring
Legal name.
entityTypeenum
accountDetailslist of objects
routingDetailslist of objects
createdAtdatetime
statusReasonenum or null
addressobject
activatedAtdatetime or null

Errors

400
Bad Request Error
401
Unauthorized Error