Skip to main content
POST
Onboard a bank-transfer user
Provider sandbox on this deployment. Our backend targets the bank provider’s sandbox: bank details are test details, no real transfer settles, and settlement lands on a testnet (read network from GET /v1/config). Known limits: only the EUR/IBAN rail is wired for the simulated pay-in, and identity checks run on test-mode applicants. Every response says which environment answered in its environment field.

Authorizations

Authorization
string
header
required

Your API key, issued by us and shown once at creation.

Body

application/json
authCode
string
required

One-time authorization code from the identity provider's button in your UI.

Minimum string length: 1
applicantInfo
object
required

The two fields the identity provider does not share and the bank provider requires.

wallet
string
required

The user's EVM wallet - the non-custodial USDC destination.

Pattern: ^0x[0-9a-fA-F]{40}$
Example:

"0x1111111111111111111111111111111111111111"

individual
object
required

Response

Onboarded, or consent still needed.

environment
enum<string>
required

Which environment answered. sandbox: at least one money upstream is the provider's sandbox - no real money moves there, and the card corridor is the sandbox's asset (read GET /v1/config), not the documented production one. production: every configured upstream is real. Derived from the configured upstream hosts at boot, never a flag.

Available options:
sandbox,
production
Example:

"sandbox"

status
string
required
Allowed value: "onboarded"
accountId
string
required

The user's account id at the bank provider.

walletId
string
required

The linked wallet id (the settlement destination).

kycStatus
string
required

KYC status right after creation.

Example:

"pending"