Endorsement
Rails / features the customer is requesting access to. Each endorsement has independent requirements the customer must clear during KYC.
Supported
base: required. Basic account + crypto/USD rails.cop: Colombian peso payouts viaco_bank_transfer.faster_payments: UK Faster Payments.pix: Brazil Pix.sepa: Eurozone SEPA.spei: Mexico SPEI.
For the countries and rails the platform covers, see Local rails.
Not supported
cards: we don't run a card program. Requesting this endorsement is accepted for shape parity but the capability will stayinactive. Related/cards/*endpoints return501 not_implemented(see Not implemented).
Endorsements appear in two places:
- On the request: an array of strings, e.g.
"endorsements": ["base", "sepa"]. - On the response: an array of
EndorsementResponseobjects: the endorsement name plus status + requirements.
EndorsementResponse
| Field | Type | Notes |
|---|---|---|
name | Endorsement | |
status | incomplete | approved | revoked | |
requirements.complete | array of string | Satisfied requirement ids. |
requirements.pending | array of string | Requirement ids currently in-flight. |
requirements.missing | object | Requirement-id keyed map of what still needs to be done. |
requirements.issues | array of string or object | Validation errors on submitted fields. |
