Offline Aadhaar API

13 min

An Overview

This API service reads the data directly from the URL of the ZIP or XML file of an Offline Aadhaar to collect all the details.

In the case of a zip file, you have to pass the password in the request body.
In the case of XML, a file password is not required.

How to call the API

Before going for Auto reading, you first need to create an Identity object. The API responds with a JSON object upon creating a request.

API Input Guidelines

A Zip file, or
An XML file
Size ?

Step 1: Hit Identities API

Sample cURL

Preproduction

Production

curl --location --request POST '<https://preproduction.signzy.tech/api/v2/patrons/..PatronId../identities'> \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "aadhaar",
    "email": "<email Id> ",
    "callbackUrl": "<https://www.w3schools.com",>
    "images": [<Images Url>]
}'

curl --location --request POST '<https://signzy.tech/api/v2/patrons/..PatronId../identities'> \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "aadhaar",
    "email": "<email Id>",
    "callbackUrl": "<https://www.w3schools.com",>
    "images": [<Image Url>]
}'

Input Parameters

Parameter Name	Required/Optional	Description
Authorization	Required	Contains the id parameter returned from the login step
Content-Type	Required	application/json
type	Required	Type of identity
email	Required	e-mail ID
callbackurl	Required	URL where response will be posted
images	Required	Front and back image of aadhaar

Sample Response

{
    "type": "aadhaar",
    "email": " ",
    "callbackUrl": "<https://www.w3schools.com",>
    "images": [],
    "accessToken": " ",
    "autoRecognition": [],
    "verification": [],
    "forgeryCheck": [],
    "id": " ",
    "patronId": " "
}

Response Parameter

Parameters Name	Data Type	Description
type	String	Application/ JSON
email	String	email id
Callbackurl	String	URL where response will be posted
images	String	url containing image
accessToken	String	Access token for the identity object
autoRecognition	String	AutoRecognition
verification	String	It verifies
forgeryCheck	String	It checks for forgery occurances
id	String	Contains the Identity object id
patronid	String	Unique Patron ID

Step 2: Hit Snoops API and receives a response

Sample Curl

Preproduction

Production

curl --location --request POST '<https://preproduction.signzy.tech/api/v2/snoops'> \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
    "service": "Identity",
    "itemId": "<Item ID",
    "accessToken": "<access token>",
    "task": "offlineAadhaar",
    "essentials": {
        "url": "< >",
        "password": "<Password of the zip file>",
        "email": "<e-mail address of the Aadhaar holder>",
        "mobile": "<Mobile Number of the Aadhaar holder>"
    }
}'

curl --location --request POST '<https://signzy.tech/api/v2/snoops'> \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
    "service": "Identity",
    "itemId": "<Item ID",
    "accessToken": "<access token>",
    "task": "offlineAadhaar",
    "essentials": {
        "url": "< >",
        "password": "<Password of the zip file>",
        "email": "<e-mail address of the Aadhaar holder>",
        "mobile": "<Mobile Number of the Aadhaar holder>"
    }
}'

Input Parameters

Parameters Name	Description
content-Type	Application/ JSON
service	type-identity
itemId	Contains the Identity object id
accessToken	Access token for the identity object
task	offline Aadhaar
essentials	contains the URL and password of the file.
essentials.url	url of the zip file
essentials.password	password of the zip file
essentials.email	e-mail address of the Aadhaar holder
essentials.mobile	Mobile Number of the Aadhar holder

API Response

{
    "service": "Identity",
    "itemId": " ",
    "task": "offlineAadhaar",
    "essentials": {
        "url": " ",>
        "password": "<Password of the zip file>",
        "email": "<email ID of aadhaar card holder>",
        "mobile": "<Mobile Number of user>",
        "instance": {
            "id": " ",
            "callbackUrl": "<https://www.w3schools.com">
        }
    },
    "accessToken": " ",
    "id": " ",
    "response": {
        "url": " ",>
        "id": " ",
        "result": {
            "name": " ",
            "dob": "01/01/1998",
            "yob": "1998",
            "gender": "MALE",
            "emailHash": " ",
            "mobileNoHash": " ",
            "address": " ",
            "photo": " ",>
            "uidLast4Digits": "6603",
            "uid": "XXXXXXXX6603",
            "generationDate": "26/10/2021",
            "generationTime": "15:01:42",
            "unixTimeStamp": 1635240702,
            "dateDifference": 0,
            "expiryTime": "",
            "emailHashVerified": "yes",
            "mobileHashVerified": "yes",
            "splitAddress": {
                "district": [
                    "EAST DELHI"
                ],
                "state": [
                    [
                        "DELHI",
                        "DL"
                    ]
                ],
                "city": [
                    "DELHI"
                ],
                "pincode": "110092",
                "country": [
                    "IN",
                    "IND",
                    "INDIA"
                ],
                "addressLine": "<Address of Aadhaar holder>"
            },
            "x509Data": {
                "subjectName": " ",
                "certificate": " ",
                "details": {
                    "version": 2,
                    "subject": {
                        "countryName": "IN",
                        "organizationName": "UIDAI",
                        "organizationalUnitName": "Technology Centre",
                        "postalCode": "560092",
                        "stateOrProvinceName": "Karnataka",
                        "streetAddress": "bangalore",
                        "houseIdentifier": "UIDAI Tech Centre, Aadhar Complex, NTI Layout, Tat",
                        "serialNumber": " ",
                        "commonName": "DS UIDAI 01"
                    },
                    "issuer": {
                        "countryName": "IN",
                        "organizationName": "Capricorn Identity Services Pvt Ltd.",
                        "organizationalUnitName": "Certifying Authority",
                        "postalCode": "110092",
                        "stateOrProvinceName": "DELHI",
                        "streetAddress": "18,LAXMI NAGAR DISTRICT CENTER",
                        "houseIdentifier": "G5,VIKAS DEEP BUILDING",
                        "commonName": "Capricorn CA 2014"
                    },
                    "serial": "02FE6F53",
                    "notBefore": "2020-05-27T05:03:05.000Z",
                    "notAfter": "2023-05-27T05:03:05.000Z",
                    "subjectHash": "db8cc5b5",
                    "signatureAlgorithm": "sha256WithRSAEncryption",
                    "fingerPrint": " ",
                    "publicKey": {
                        "algorithm": "sha256WithRSAEncryption"
                    },
                    "altNames": [],
                    "extensions": {
                        "extendedKeyUsage": "Microsoft Smartcardlogin, E-mail Protection, TLS Web Client Authentication, 1.3.6.1.4.1.311.10.3.12, 1.2.840.113583.1.1.5",
                        "authorityKeyIdentifier": "keyid:43:80:04:A0:07:B5:E0:CF",
                        "authorityInformationAccess": "OCSP - URI:<http://ocvs.certificate.digital/\nCA> Issuers - URI:<https://www.certificate.digital/repository/CapricornCA2014.cer",>
                        "certificatePolicies": "Policy: 2.16.356.100.2.3\n  User Notice:\n    Explicit Text: Class 3 Certificate issued by Capricorn Certifying Authority\nPolicy: 2.16.356.100.10.1\n  User Notice:\n    Explicit Text: Organizational Document Signer Certificate\nPolicy: 2.16.356.100.1.10.2\n  CPS: <https://www.certificate.digital/repository/cpsv1.pdf",>
                        "cRLDistributionPoints": "Full Name:\n  URI:<https://www.certificate.digital/crl/CapricornCA.crl",>
                        "subjectKeyIdentifier": "4D:F9:2C:CF:41:DA:50:55",
                        "keyUsage": "Digital Signature, Non Repudiation",
                        "subjectAlternativeName": "email:[email protected]",
                        "basicConstraints": "CA:FALSE"
                    }
                },
                "validAadhaarDSC": "yes"
            }
        },
        "instance": {
            "id": " ",
            "callbackUrl": "<https://www.w3schools.com">
        }
    }
}

Output Parameters

PARAMETER NAME	DESCRIPTION
service	type-identity
itemId	Contains the Identity object id
task	Type of task to be performed
essentials	Essential part of the request
essentials.url	url of the zip file
essentials.password	password of the zip file
essentials.email	e-mail address of the Aadhaar holder
essentials.mobile	Mobile number of Aadhaar holder
essentials.instance.id	holds instance id value
essentials.instance.callbackUrl	Url where result will be posted
name	The name of the Aadhaar card holder.
dob	The date of birth of the Aadhaar Card holder.
gender	The gender of the Aadhaar card holder.
emailHash	This parameter contains the hashed value of the email ID of Aadhaar holder.
mobileNoHash	This parameter contains the hashed value of the mobile number of the Aadhaar holder.
x509Data	This parameter contains the digital certificate information of the Aadhaar Card.
x509Data.subjectName	This parameter shows the subject name and version used for displaying the Aadhaar digital Certificate.
x509Data.certificate	The digital certificate ID for the Aadhaar card.
x509Data.details	This parameter contains the details of the digital certificate including DSC validator of Aadhaar Card.
address	The address details of the Aadhaar Card holder is displayed here.
photo	The URL of the uploaded Aadhaar Card image.
splitAddress	This parameter distinguishes the various parts of the address of the Aadhaar holder into separate categories like district, state, city, pincode and country. For the country category, acceptable values are “IN”,”IND”and”INDIA”.
splitAddress.addressLine	The first line of the address is displayed by this parameter.

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].