Ramp

Get user KYC state

Returns the Chainrails KYC state and transaction requirements for a user.

get/ramp/kyc

Request

Base URL
https://api.chainrails.io/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/horuslabsio/apis/chainrails-api/docs/ramp/kyc/get.ts
A function with typed inputs. Its response is checked against the schema.

provider'FONBNK' | 'ONRAMP_MONEY' | 'GUARDARIAN' | 'YELLOW_CARD' required

The ramp provider to query KYC state for

userEmailstring required

Example:user@example.com

The end-user's email address

countryCodestring required

Example:NG

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

fiatCurrencystring required

Example:NGN

ISO 4217 fiat currency code

cryptoAmountnumber

Example:25

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

KYC state

Aug 12, 2026dcf19c1bab20 Revision changes
- breaking
  added the new required query request parameter fiatCurrency
- info
  added the new enum value YELLOW_CARD to the query request parameter provider
Jul 22, 202676a4e00b118d Revision changes
- info
  endpoint added