KYB Requirements

KYB requirements details

This endpoint returns required KYB 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 KYB flow), click here.

GET https://api.onramp.money/onramp/api/v2/whiteLabel/kyb/requirements

200: OK

{
    "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
            }
        },
        "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"
                ]
            }
        }
    }
}

400: Bad Request country is missing

Response

{
    "status": 1,
    "code": 200,
    "data": {
        "kybRequirements": [
            {
                "fieldName": "entityName",
                "required": true,
                "type": "TEXT"
            },
            {
                "fieldName": "tradingName",
                "required": false,
                "type": "TEXT"
            },
            {
                "fieldName": "legalEntityNature",
                "required": true,
                "type": "TEXT"
            },
            {
                "fieldName": "purposeOnOnramp",
                "required": true,
                "type": "TEXT"
            },
            {
                "fieldName": "companyRegistrationNumber",
                "required": true,
                "type": "TEXT"
            },
            {
                "fieldName": "registeredEntityAddress",
                "required": true,
                "type": "TEXT"
            },
            {
                "fieldName": "operationalAddressOfEntity",
                "required": true,
                "type": "TEXT"
            },
            {
                "fieldName": "companyTaxId",
                "required": true,
                "type": "TEXT"
            },
            {
                "fieldName": "ownershipDetailsAndControlStructure",
                "required": true,
                "type": "TEXT"
            },
            {
                "fieldName": "sourceOfFund",
                "required": true,
                "type": "TEXT"
            },
            {
                "fieldName": "natureOfBusiness",
                "required": true,
                "type": "TEXT"
            },
            {
                "fieldName": "uboDetails",
                "required": true,
                "type": "TEXT"
            },
            {
                "fieldName": "directorsDetails",
                "required": true,
                "type": "TEXT"
            },
            {
                "fieldName": "companyRepDetails",
                "required": true,
                "type": "TEXT"
            },
            {
                "fieldName": "incorporationCertificate",
                "required": true,
                "type": "FILE_UPLOAD"
            },
            {
                "fieldName": "taxId",
                "required": true,
                "type": "FILE_UPLOAD"
            },
            {
                "fieldName": "companyDocs",
                "required": true,
                "type": "FILE_UPLOAD"
            },
            {
                "fieldName": "moneyMovementFlowchart",
                "required": false,
                "type": "FILE_UPLOAD"
            },
            {
                "fieldName": "auditedFinancialStatementsOfLegalEntity",
                "required": true,
                "type": "FILE_UPLOAD"
            },
            {
                "fieldName": "uboDocs",
                "required": true,
                "type": "FILE_UPLOAD"
            },
            {
                "fieldName": "directorsKycDocs",
                "required": true,
                "type": "FILE_UPLOAD"
            },
            {
                "fieldName": "companyRepDocs",
                "required": true,
                "type": "FILE_UPLOAD"
            }
        ]
    }
}

Explanation

• kybRequirements -> all required kyb data parameters and kyb file for KYB verification.