KYC Requirements

KYC requirements details

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

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

• 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://integration.coinmena.com/onramp-bank/api/v1/kyc/requirements

Query Parameters

Name	Type	Description
fiatType*	Integer	(3 -AED)
customerId*	String	customerId returned from /kyc/url

200: OK

{
    "status": 1,
    "code": 200,
    "kycRequirementData": {
        "identityNumber": {
            "label": "Identity Number",
            "inputMode": "numeric",
            "required": 1
        },
        "details": {
            "idExpirationDate": {
                "regex": "^(?:19|20)dd-(0[1-9]|1[0-2])-(0[1-9]|[12]d|3[01])$",
                "label": "Expiry Date",
                "type": "date",
                "required": 1
            },
            "firstName": {
                "regex": "^(?!\\s).*$",
                "label": "First Name",
                "required": 1
            },
            "firstSurname": {
                "regex": "^(?!\\s).*$",
                "label": "First Surname",
                "required": 1
            },
            "secondSurname": {
                "regex": "^(?!\\s).*$",
                "label": "Second Surname",
                "required": 0
            },
            "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
            },
            "gender": {
                "regex": "^[a-zA-Z]+$",
                "label": "Gender",
                "type": "select",
                "required": 1
            },
            "nationality": {
                "regex": "^[a-zA-Z]+$",
                "label": "Nationality",
                "type": "list",
                "required": 1
            }
        },
        "documents": {
            "1": {
                "idName": "Passport",
                "files": [
                    "passportFront.jpg"
                ]
            }
        }
    }
}

400: Bad Request parameters is/are missing

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

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"
                }
            }
        }