Sign in
Ramp

Get user KYC state

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

get/ramp/kyc

Query parameters

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.

Response

KYC state

Changes

Changed in 2 of the 9 revisions of this API.12

  • dcf19c1bab2011See the full diff
    • ▲

      added the new required query request parameter fiatCurrency

      new-required-request-parameter

    • ○

      added the new enum value YELLOW_CARD to the query request parameter provider

      request-parameter-enum-value-added

  • 76a4e00b118d1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog