KYC Requirements

KYC requirements details

This endpoint returns required KYC requirements details specific to the country.

• Supported Currencies: To view the list of all the fiat currencies supported by Onramp(all countries not supported for this KYC flow), click here.

• If a country is included in the address key of KYC requirement json, provide the Alpha-2 code (for FRANCE , the alpha-2 code is FR) for that particular country in address key.

• Date of Birth (DOB) sent as YYYY-MM-DD format.

• For certain countries (VND, THB, ZAR, NGN), the response includes a KYC widget URL(kycLink). You should pass the redirectUrl parameter to direct users back to the client page after completing the KYC process.

• type is the identity type of document, to be sent in KYC endpoints as per the requirements.

  Below is documents key from the json response:

  "documents": {
      "1": { // type of the id, to be sent in request body
                  "idName": "National ID ",
                  "files": [
                      "idFront1.jpg",
                      "idBack1.jpg",
                      "selfie.jpg"
                  ]
              },
              "3": { // type of the id, to be sent in request body
                  "idName": "Passport",
                  "files": [
                      "passportFront.jpg",
                      "passportBack.jpg",
                      "selfie.jpg"
                  ]
              },
              "4": { // type of the id, to be sent in request body
                  "idName": "Driving License",
                  "files": [
                      "drivingLicenseFront.jpg",
                      "drivingLicenseBack.jpg",
                      "selfie.jpg"
                  ]
              }
          }
  

POST https://api.onramp.money/onramp/api/v2/whiteLabel/kyc/requirements

Query Parameters

Name	Type	Description
fiatType*	Integer	(12 - EUR, 15 - KES)
customerId*	String	customerId returned from /kyc/url
redirectUrl	String	E.g. https://api.client.com For certain countries (VND, THB, ZAR, NGN), the response includes a KYC widget URL. You should pass the redirectUrl parameter to direct users back to the client page after completing the KYC process.

200: OK

Sample Response

{
    "status": 1,
    "code": 200,
    "data": {
        "identityNumber": {
            "regex": "^[a-zA-Z0-9]*$",
            "label": "Identity Number",
            "required": 1
        },
        "details": {
            "firstName": {
                "regex": "^(?!\\s).*$",
                "label": "First Name",
                "required": 1
            },
            "firstSurname": {
                "regex": "^(?!\\s).*$",
                "label": "First Surname",
                "required": 0
            },
            "secondSurname": {
                "regex": "^(?!\\s).*$",
                "label": "Second Surname",
                "required": 1
            },
            "dob": {
                "regex": "^(?:19|20)dd-(0[1-9]|1[0-2])-(0[1-9]|[12]d|3[01])$",
                "label": "Date of Birth",
                "type": "date",
                "required": 1
            },
            "sourceOfFunds": {
                "label": "Source of Funds",
                "type": "select",
                "required": 1
            },
            "sex": {
                "regex": "^[a-zA-Z]+$",
                "label": "Sex",
                "type": "select",
                "required": 1
            }
        },
        "address": {
            "addressLine1": {
                "label": "Address Line 1",
                "required": 1
            },
            "addressLine2": {
                "label": "Address Line 2",
                "required": 0
            },
            "city": {
                "regex": "^[a-zA-Z ]+$",
                "label": "City",
                "required": 1
            },
            "postalCode": {
                "regex": "^[a-zA-Z0-9 ]+$",
                "label": "Postal Code",
                "required": 1
            },
            "country": {
                "regex": "^[a-zA-Z0-9 ]+$",
                "label": "Country",
                "required": 1,
                "detail": "Alpha-2 country code"
            },
            "countryName": {
                "regex": "^[a-zA-Z]+$",
                "label": "Country Name",
                "required": 1
            }
        },
        "documents": {
            "1": {
                "idName": "National ID ",
                "files": [
                    "idFront1.jpg",
                    "idBack1.jpg",
                    "selfie.jpg"
                ]
            },
            "3": {
                "idName": "Passport",
                "files": [
                    "passportFront.jpg",
                    "passportBack.jpg",
                    "selfie.jpg"
                ]
            },
            "4": {
                "idName": "Driving License",
                "files": [
                    "drivingLicenseFront.jpg",
                    "drivingLicenseBack.jpg",
                    "selfie.jpg"
                ]
            }
        }
    }
}

200: OK (kycLink)

{
    "status": 1,
    "code": 200,
    "kycRequirementData": {
        "kycLink": "https://test.onramp.money/onramp-kyc/?tid=bd1DQE_51&countryId=5&redirectUrl=https://api.clientUrl.com"
    }
}

200: OK (India)

{
  "status": 1,
  "code": 200,
  "data": {
    "identityNumber": {
      "regex": "^[0-9]{12}$",
      "label": "Aadhaar Number",
      "required": 1
    },
    "incomeTaxNumber": {
      "regex": "^[A-Z]{5}[0-9]{4}[A-Z]{1}$",
      "label": "PAN (Income Tax Number)",
      "required": 1
    },
    "details": {
      "geoData": {
        "label": "Geo Location Data",
        "required": 1,
        "lat": {
          "label": "Latitude",
          "required": 1
        },
        "long": {
          "label": "Longitude",
          "required": 1
        }
      },
      "ip":{
        "label": "Ip Address",
        "required": 1,
      }
    },
    "documents": {
      "1": {
        "idName": "National ID",
        "files": [
          "aadhaar.xml",
          "incomeTaxFront1.jpg", //  "incomeTax.pdf" (either of these two is required)
          "selfie.jpg",
          "audio.webm",
          "video.webm"
        ]
      }
    }
  }
}

400: Bad Request parameters is/are missing

{
    "status": 0,
    "code": 400,
    "error": "Missing required parameter(s) -> fiatType, customerId or appId."
}

400: Bad Request Invalid customerId

{
    "status": 0,
    "code": 400,
    "error": "Invalid customerId."
}

Documents Explaination

 "documents": {
            "1": { //type to be sent in request body while submitting details or files
                "1": { 
                    "key": "idFront1.jpg"
                },
                "2": {
                    "key": "idBack1.jpg"
                },
                "3": {
                    "key": "selfie.jpg"
                }
            },
            "3": { //type
                "1": {
                    "key": "passportFront.jpg"
                },
                "2": {
                    "key": "passportBack.jpg"
                },
                "3": {
                    "key": "selfie.jpg"
                }
            },
            "4": { //type
                "1": {
                    "key": "drivingLicenseFront.jpg"
                },
                "2": {
                    "key": "drivingLicenseBack.jpg"
                },
                "3": {
                    "key": "selfie.jpg"
                }
            }
        }