Ramp

Submit KYC information

Submits available KYC fields. The Chainrails KYC engine determines whether text validation, external verification, or both are required.

post/ramp/kyc

Request body

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

The ramp provider to submit KYC to

userEmailstring required

The end-user's email address

countryCodestring required

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

fiatCurrencystring required

ISO 4217 fiat currency code

fieldsobject

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.

callbackUrlstring

URL to redirect the user to after external KYC verification.

cryptoAmountnumber

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

Example request

{
  "provider": "YELLOW_CARD",
  "userEmail": "user@example.com",
  "countryCode": "NG",
  "fiatCurrency": "NGN",
  "fields": {
    "first_name": "John",
    "last_name": "Doe",
    "date_of_birth": "1990-01-01",
    "BVN": "12345678901"
  },
  "callbackUrl": "https://app.example.com/kyc/complete",
  "cryptoAmount": 25
}

Response

Updated KYC state after submission

Changes

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

Aug 12, 2026dcf19c1bab20123See the full diff
- ▲
  added the new required request property fiatCurrency
  new-required-request-property
- ●
  removed the request property documentId
  request-property-removed
- ●
  removed the request property userFields
  request-property-removed
- ○
  added the new optional request property callbackUrl
  new-optional-request-property
- ○
  added the new optional request property fields
  new-optional-request-property
- ○
  added the new YELLOW_CARD enum value to the request property provider
  request-property-enum-value-added
Jul 22, 202676a4e00b118d1See 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

Full history