Skip to main content
POST
Submit KYC fields and start any required verification

Authorizations

Authorization
string
header
required

Enter your Chainrails API key as a Bearer token

Body

application/json
email
string
required
countryCode
string
required

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

Example:

"NG"

provider
enum<string>
required
Available options:
FONBNK,
ONRAMP_MONEY,
GUARDARIAN,
YELLOW_CARD
Example:

"YELLOW_CARD"

fiatCurrency
string
required
Example:

"NGN"

fields
object

Optional KYC fields. country is the user’s current country of residence. Supported fields: email, first_name, last_name, phone, date_of_birth, country, BVN, NIN, and address.

Example:
callbackUrl
string

URL Didit should redirect the user to after external verification.

Example:

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

amountUsd
number
Example:

100

Response

201