Skip to main content
GET
Get user KYC state

Authorizations

Authorization
string
header
required

Enter your Chainrails API key as a Bearer token

Query Parameters

provider
enum<string>
required

The ramp provider to query KYC state for

Available options:
FONBNK,
ONRAMP_MONEY,
GUARDARIAN,
YELLOW_CARD
userEmail
string
required

The end-user's email address

countryCode
string
required

ISO 3166-1 alpha-2 transaction/corridor country. This does not update the user’s country of residence.

Example:

"NG"

fiatCurrency
string
required

ISO 4217 fiat currency code

Example:

"NGN"

cryptoAmount
number

Amount of crypto (USDC) the user intends to receive. When provided, the response includes requiredKycType and canProceed.

Example:

25

Response

KYC state