Previous Next JavaScript must be enabled to correctly display this content

## 6.4.3 National Identification Validation

This topic provides the information about the payload details for National Identification validation service.

National ID card Details Validation module extracts details in the National Identity Card like Name, First Name, Last Name, Gender, Address (if present), Date of Birth, Date of Issue and Date of expiry of the NID, ID No, etc along with the image metadata information like Image DPI, Resolution and Size. Then it calculates similarity scores for each input key value pairs with the extracted details. This module provides support for NIDs of various countries listed below:

- USA
- SOUTH AFRICA
- BRAZIL
- BANGLADESH
- CANADA
- INDIA
- KENYA
- PORTUGAL

All the details in the license are extracted and validated using "/validateInformation" API.

Brief of Working:

It takes "country", "key value pairs to be searched", "input documents" (including "document type" and "Base64 encoded image") of the passport as input. It internally generates processed text from the passport and extracts details like Name, First Name, Last Name, Gender, DOB, DOI and DOE, PP No. and Issuing Authority if present in the document. Along with the document details, it also gives image metadata information like Image DPI, Resolution and Size, etc. Then it calculates similarity scores for each input key value pairs with the extracted details. The output is represented in JSON format.

Input Request:

"/validateInformation" API -

- • Country, Array of key value pairs to be searched, Array of the documents (including Base64 encoded image and Document Type ("nid" in this case) for each document).

Sample Input Request:

    {
        "country": "BR",
        "search": [
            [
                {
                  "key": "------name of key------"
                  "value": "------value of key------"
                }
            ]
        ],
        "docs": [
            {
              "docType": "nid",
                "docBase64s": "------base64 encoded image string------"
            }
        ]
    }

Output Response:

The output of "/validateInformation" API is the extracted details in the JSON format given below:

Sample Output Response:

    {
         "documentDetails": [
            {
                "country": "BR",
                "documents": {
                            {
                                "extractedValue": "FERNANDA DE CARVALHO DA SILVA",
                                "key": "name",
                                "similarityScore": 68.97,
                                "value": "FERNANDA DE CARVALHO"
                            },
                            {
                                "extractedValue": "000000005-9",
                                "key": "identificationNumber",
                                "similarityScore": 100.0,
                                "value": "000000005-9"
                            },
                            {
                                "extractedValue": "NA",
                                "key": "date",
                                "similarityScore": 0.0,
                                "value": "12/7/1960"
                            },
                            {
                                "extractedValue": "BRAZIL",
                                "key": "issuedCountry",
                                "similarityScore": 100.0,
                                "value": "BRAZIL"
                            }
                        ]
                    ]
                }
            }
        ]
     }

Parent topic: Validate Information API details