Skip to main content
GET
Get registration requirements

Authorizations

Authorization
string
header
required

API key sent in the Authorization header, with no Bearer prefix.

Path Parameters

organizationId
string<uuid>
required

The organization this call acts for: your API key's organization or one of its customer organizations. Any other id returns 404 not-found.

Query Parameters

kind
enum<string>
required

The kind of account. embeddedWallet is a wallet we create on a chain; see Embedded wallets. debitCard and cash return 422 unsupported.

Available options:
bank,
wallet,
embeddedWallet,
debitCard,
cash
country
string

Two-letter country code. Omit for a wallet.

currency
string

Three-letter currency code. Omit for a wallet.

accountDetailsKind
enum<string>
required

The accountDetails.kind you would register, for example clabe. The kind of identifier that names the account. signerPublicKey names an embeddedWallet account by the P-256 key that controls it.

Available options:
clabe,
pixKey,
address,
signerPublicKey

Response

The fields to send.

accountDetails
object
required
registrationInfo
object
required