Get Eaadhaar

9 min

Introduction

Once the end user has given the consent to his/her Diglocker account, you can use this API call to get the e-Aadhaar data. You will get the last 4 digits of the Aadhaar card, Name, DOB, Address, etc.

How to call the API

You will need to log in before sending the request. You are required to pass the access token received from the login call, as the authorization header in the request.

API Input Guidelines

You need to make sure that your input parameter requestId is authorized before you call this API.

Sample Curl

Preproduction

Production

curl --location --request POST 'https://api-preproduction.signzy.app/api/v3/digilocker/geteAadhaar' \
--header 'Authorization: <auth-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId" : "<request ID>",
    "extraDigitalCertificateParams":"<boolean> (optional)
}'

curl --location --request POST 'https://api.signzy.app/api/v3/digilocker/geteAadhaar' \
--header 'Authorization: <auth-token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId" : "<request ID>"
}'

Input Parameters

FIELD	DESCRIPTION	TYPE	REQUIRED
requestId	...requestId...	String	Required
extraDigitalCertificateParams	To get SignatureData	boolean	optional

Sample Response

{
    "result": {
        "name": "",
        "uid": "",
        "dob": "",
        "gender": "",
        "x509Data": {
            "subjectName": "",
            "certificate": "",
            "details": {
                "version": <version>,
                "subject": {
                    "countryName": "",
                    "organizationName": "",
                    "organizationalUnitName": "",
                    "postalCode": "",
                    "stateOrProvinceName": "",
                    "streetAddress": "",
                    "houseIdentifier": "",
                    "serialNumber": "",
                    "commonName": ""
                },
                "issuer": {
                    "countryName": "",
                    "organizationName": "",
                    "organizationalUnitName": "",
                    "commonName": ""
                },
                "serial": "",
                "notBefore": "",
                "notAfter": "",
                "subjectHash": "",
                "signatureAlgorithm": "",
                "fingerPrint": "",
                "publicKey": {
                    "algorithm": ""
                },
                "altNames": [],
                "extensions": {
                    "basicConstraints": "",
                    "keyUsage": "",
                    "extendedKeyUsage": "",
                    "authorityKeyIdentifier": "",
                    "subjectKeyIdentifier": "",
                    "subjectAlternativeName": "",
                    "cRLDistributionPoints": "",
                    "authorityInformationAccess": "",
                    "certificatePolicies": ""
                }
            },
            "validAadhaarDSC": ""
            
            
        },
        "address": "",
        "photo": "",
        "splitAddress": {
            "district": [
                ""
            ],
            "state": [
                [
                    ""
                ]
            ],
            "city": [
                ""
            ],
            "pincode": "",
            "country": [
                "IN",
                "IND",
                "INDIA"
            ],
            "addressLine": "",
            "landMark": ""
        }
         "signatureData": {
    "xmlns": "",
    "SignedInfo": {
      "CanonicalizationMethod": {
        "Algorithm": ""
      },
      "SignatureMethod": {
        "Algorithm": ""
      },
      "Reference": {
        "URI": "",
        "Transforms": {
          "Transform": {
            "Algorithm": ""
          }
        },
        "DigestMethod": {
          "Algorithm": ""
        },
        "DigestValue": ""
      }
    },
    "SignatureValue": "",
    "KeyInfo": {
      "X509Data": {
        "X509SubjectName": [],
        "X509Certificate": []
      }
    }
  }
    }
    
}

Response Parameter

FIELD	DESCRIPTION	TYPE
result	Contains content of response	String
name	...name...	String
dob	...date of birth...	String
gender	...gender...	String
x509Data	...data regarding the authenticity provided with the eaadhaar...	Object
validAadhaarDSC	...is eaadhaar certificate valid or not (yes/no)...	String
address	...address...	String
photo	...link to photo as on eaadhaar...	String
splitAddress	...contains components of address...	Object
district	[ "...district name..."]	Array
state	[ "...state name...", "...2 digit state code..." ]	Array
city	["...city name..."]	Array
pincode	...pincode...	String
country	[ "...2 digit ISO country name...", "...3 digit ISO country name...", "...country name..." ]	Array
addressLine	...address...	String

Sample Error

{
    "message": "No API key found in request"
}

Error Parameter

PARAMETER NAME	DESCRIPTION
error	This parameter contains the error.
error.name	the name of the error
error.message	the error message
error.status	status of the api
error.statusCode	Request Status code from Signzy
error.reason	Reason for error
error.type	Type of the error

Error Codes

CODE	DESCRIPTION
400	Invalid inputs
401	Authorization token is invalid
409	If Upstream service not reachable

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].