API Reference
API ReferenceChangelogFAQDashboard

India

This page provides example of the E_KYC_CHECK response for India.

Aadhaar (Digilocker)

{
  "checks": [
    {
      "answer": "GREEN",
      "checkType": "E_KYC_CHECK",
      "createdAt": "2025-02-06 11:15:11",
      "id": "efcee38a-756f-4c77-854f-8831912a1d12",
      "inputDoc": {
        "idDocType": "OTHER",
        "country": "IND"
      },
      "extractedDoc": {
        "country": "IND",
        "number": "xxxx-xxxx-1234",
        "firstName": "Arjun Kumar",
        "gender": "M",
        "dob": "1990-12-30",
        "tin": "ABCDE9182F",
        "addresses": [
          {
            "street": "2nd Main Road",
            "buildingNumber": "House No. 42, Green View Residence",
            "town": "Salem",
            "state": "Tamil Nadu",
            "postCode": "636007",
            "country": "IND",
            "formattedAddress": "S/O: Arjun Kumar, House No. 42, Green View Residence, 2nd Main Road, Near Community Hall, Suramangalam Post Office, Salem Taluk, Salem, Tamil Nadu, 636007"
          }
        ],
        "images": [
          {
            "imageId": 133092848
          }
        ]
      },
      "ekycCheckInfo": {
        "confirmationId": "J2YY2vDoQvncsIDpzj2BKoEH",
        "confirmationType": "oAuth"
      }
    }
  ]
}

Response explained

The response represents a singleton list of checks.

Root variables

The root variables are the core Identity check result data items. Some of them may include nested attributes and element fields.

FieldTypeDescription
idStringUnique identifier of the check.
answerStringCheck answer:
  • GREEN — the check has passed successfully. Data found in the database.
  • YELLOW — verification process is not yet complete. We await the applicant's completion of the required steps.
checkTypeStringIndicates that it is a E_KYC_CHECK check type.
createdAtDateDate and time (UTC) of the latest Non-Doc check result.
inputDocObjectRepresents the data used for the E_KYC_CHECK check.
extractedDocObject External check source data. It may not be present if the data is not received.

inputDoc attributes

The following table explains the inputDoc attributes representing the data taken from the provided document.

FieldTypeDescription
idDocTypeStringType of the document provided for verification. For example, TAX_PAYER_NUMBER_DOC, ID_CARD, PASSPORT, DRIVERS.
countryStringAlpha-3 country code (for example, DEU, GBR, ARG, and so on).

extractedDoc attributes

The extractedDoc object includes the data obtained from the external source during the E_KYC_CHECK check.

FieldTypeDescription
countryStringAlpha-3 country code (for example, DEU, GBR, ARG, and so on).
numberStringMasked Aadhaar number.
firstNameStringApplicant full name.
dobDateApplicant date of birth (format YYYY-mm-dd, e.g. 2001-09-25).
genderStringApplicant gender (M or F).
addressesList of ObjectsThe list of addresses extracted from the external check sources.
tinStringPAN number, if available.
images[0].imageIdIntegerImage ID of the selfie photo from the database.

addresses attribute

The following table explains the addresses element fields containing the applicant address details extracted from external sources.

FieldTypeDescription
streetStringStreet name.
buildingNumberStringBuilding number.
townStringCity, town, or another settlement.
stateStringState, region, district, county or another territorial entity inside a country.
postCodeStringAddress postal code.
countryStringAlpha-3 country code (for example, DEU, GBR, ARG, and so on).
formattedAddressStringAddress in an human-readable format, including the following details: {care of}, {building}, {street}, {landmark}, {post office}, {subdistrict}, {district}, {state}, {postal code}.