HOhoruslabsio
Ramp

Submit KYC information

Changed on

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

post/ramp/kyc

Request

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

  • dcf19c1bab20Revision changes
    • breaking

      added the new required request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new YELLOW_CARD enum value to the request property

  • 76a4e00b118dRevision changes
    • info

      endpoint added