Skip to main content
POST
Submit KYC information

Authorizations

Authorization
string
header
required

Enter your Chainrails API key as a Bearer token

Body

application/json
provider
enum<string>
required

The ramp provider to submit KYC to

Available options:
FONBNK,
ONRAMP_MONEY,
GUARDARIAN,
YELLOW_CARD
Example:

"YELLOW_CARD"

userEmail
string
required

The end-user's email address

countryCode
string
required

ISO 3166-1 alpha-2 transaction/corridor country. Submit the user’s residence separately as fields.country.

Example:

"NG"

fiatCurrency
string
required

ISO 4217 fiat currency code

Example:

"NGN"

fields
object

KYC fields available for submission. country is the user’s current country of residence. The KYC engine decides whether text validation, external verification, or both are required.

Example:
callbackUrl
string

URL to redirect the user to after external KYC verification.

Example:

"https://app.example.com/kyc/complete"

cryptoAmount
number

Amount of crypto (USDC) the user intends to receive — used to compute canProceed in the response.

Example:

25

Response

Updated KYC state after submission