For the complete documentation index, see llms.txt. This page is also available as Markdown.

National Identity

Allows merchant to verify information of users using National ID and other identifiers.

POST https://api.myidentitypay.com/api/v1/biometrics/merchant/data/verification/sa/national_id

Headers

Name
Type
Description

x-api-key*

String

<your secret key>

Request Body

Name
Type
Description

firstname*

String

first name of user

lastname*

String

lasname of user

nationalid*

String

NATIONAL ID

dob*

String

User's Date of birth

{
    "status":true,
    "message":"Information Validated",
    "response_code":"00",
    "data":{
        "completename": "",
        "formofaddress": "",
        "qualificationpreceding": "",
        "givenfullname": "",
        "givennameinitials": "",
        "qualification_int_first": "",
        "surname_prefix_first": "",
        "surname_first": "",
        "indicator": "",
        "qualification_int_second": "",
        "surname_prefix_second": "",
        "qualification_suceeding": "",
        "name_qualified": "",
        "function": "",
        "gender": "",
        "nationality": "",
        "nationalid": "",
        "organization_name": "",
        "dob": "",
        "businessid": "",
        "contact_type": "",
        "countryCode": "",
        "passport": "",
        "contactType": "",
        "nameQualified": "",
        "organizationName": "",
        "qualificationIntFirst": "",
        "qualificationIntSecond": "",
        "qualificationSuceeding": "",
        "surnameFirst": "",
        "surnamePrefixFirst": "",
        "surnamePrefixSecond": ""
    }
}

Last updated