Aadhaar API
AADHAAR AUTHENTICATION API
AADHAAR authentication service will be exposed as stateless service over HTTPS with mutual SSL authentication (server and client certificate validation). Usage of HTTP allows any device such as computer, mobile phone, micro-ATM devices, and PoS systems to communicate over broadband, GPRS, and similar communication channels.
To support strong end to end security and avoid request tampering and man-in-the- middle attacks, it is essential that encryption of data happens at the time of capture. For establishing a secure channel, AUAs are required to be registered and their public key needs to be shared with UIDAI. Process for registration and key sharing will be specified later.
Following is the URL format for AADHAAR authentication service:
https://<host>/<ac>/<uid[0]>/<uid[1]>/
API input data should be sent to this URL using POST parameter “input”.
Details
host – AADHAAR authentication server name. Currently it is “auth.uidai.gov.in”.
ac – A unique code for the AUA which is assigned by UIDAI during AUA registration process. This is an alpha-numeric string having maximum length 40.
uid[0] and uid[1] – First 2 digits of AADHAAR Number. Used for load-balancing.
For all valid responses, HTTP response code 200 is used. All application error codes are encapsulated in response XML element. In the case of connection and other server errors, standard HTTP error response codes are used (4xx codes such as 403, 404, etc.). HTTP automatic redirects also should be handled by AUA server.
Input Data Format
AADHAAR authentication will use XML as the data format for input and output. To avoid sending unnecessary data, do not pass any optional attribute or element unless its value is different from default value. Any bad data or extra data will be rejected.
Following is the data format for authentication API:
<Auth uid=”" tid=”" ac=”" ver=”" txn=”">
<Skey>encrypted and encoded session key</Skey> <Uses pi=”" pa=”" bio=”" bt=”" pin=”" otp=”"/> <Data>encrypted and then encoded block</Data> </Auth>
“Data” element contains “Pid” (Personal Identity Data) element which is a base-64 encoded encrypted block. Complete “Data” block should be encrypted at the time of capture on the capture device. See next chapter for details.
Following is the format for “Pid” element:
<Pid ts=”"> <Demo>
<Pi ms=”E” name=”" gender=”M|F|T” dob=”" phone=”" email=”"/> <Pa ms=”E” co=”" house=”" street=”" lm=”" loc=”" vtc=”" dist=”" state=”" pc=”"/> </Demo> <Bios>
<Bio>encoded biometric</Bio> <Bio type=”FMR|FIR|IIR”>encoded biometric</Bio> </Bios>
<Pv otp=”" pin=”"/> </Pid>
Details
Element: Auth (mandatory)
root element of the input XML for authentication service.
Attributes:
uid – (mandatory) AADHAAR Number of the resident
tid – (mandatory) For Registered devices, send its unique Terminal ID. For Public devices, value should be passed as “public”.
ac – (mandatory) A unique code for the AUA which is assigned by UIDAI during AUA registration process. This is an alpha-numeric string having maximum length 40.
ver – (optional) version of the API. Defaulted to latest version. Suggested to use latest version always by leaving this attribute unless an application wants specific version compatibility. Currently only valid value is “1.0″.
txn – (optional) AUA specific transaction identifier. AUA can choose to pass this as part of input. This is returned as part of response as is. This can be an alphanumeric string of maximum length 50.
Element: Data (mandatory)
Contains the encrypted “Pid” element in base-64 encoding
Element: Uses (mandatory)
This element specifies the authentication factors used by the request. When an authentication factor is specified in this element, that specific attribute must be present in the encrypted data block. This is particularly useful in situations where the AUA does not fully control the terminal device, but wishes to maintain a certain level of control on the authentication transaction.
Attributes:
pi – (mandatory) Valid values are “y” or “n”. If the value is “y” then at least one attribute of element “Pi” (part of “Demo” element) should be used in authentication. Otherwise, it is not mandated.
pa – (mandatory) Valid values are “y” or “n”. If the value is “y” then at least one attribute of element “Pa” (part of “Demo” element) should be used in authentication. Otherwise, it is not mandated.
bio – (mandatory) Valid values are “y” or “n”. If the value is “y” then at least one biometric element “Bio” (part of “Bios” element) should be used in authentication. Otherwise, it is not mandated.
bt – (mandatory only if “bio” attribute has value “y”) provide a comma separated list of biometrics used. Valid values that can be used in this comma separated list are “FMR”, “FIR”, and “IIR”. If “FMR” is part of the list, then at least one “Bio” element with type FMR should be used. Similarly, if “FIR” or “IIR” are part of the list, then at least one “Bio” element with those types must be used.
pin – (mandatory) Valid values are “y” or “n”. If the value is “y” then PIN should be used in authentication. Otherwise, “pin” is not mandated.
otp – (mandatory) Valid values are “y” or “n”. If the value is “y” then OTP should be used in authentication. Otherwise, “otp” is not mandated.
Element: Skey (mandatory only for Public devices)
Value of this element is base-64 encoded value of encrypted session key. See next chapter for encryption details.
Element: Pid (mandatory)
Attributes:
ts – (mandatory) Timestamp at the time of demographic and biometric input capture. This is in ISO 8601 date and time format “YYYY-MM-DDThh:mm:ss”. Time zone automatically defaulted to IST (UTC +5.30).
AUAs can queue authentication requests and send it to AADHAAR authentication server to support occasional lack of network connectivity on the field. Maximum time up to which requests can be queued will be defined by UIDAI policy. During initial release, this will be configured to 24 hours. All requests with “ts” value older than this limit will be rejected.
Element: Demo (optional)
- Contains child elements “Pi” and “Pa” both of which are optional.
- All demographic data fields as per KYR specifications.
Element: Pi (Optional)
- This element captures attributes related to “Personal Identity”
Attributes:
- ms – (optional) “Matching Strategy” for “name” attribute. Currently only the value “E” (Exact) is supported. This is used only when “name” attribute is specified. Future releases will support fuzzy matching.
- name – (optional) Name of the resident.
- gender – (optional) Valid values are “M” for male, “F” for female, and “T” for transgender.
- dob – (optional) Date of Birth in “YYYY-MM-DD” format. If only year needs to be authenticated, then use format “YYYY”.
- phone – (optional) Registered mobile phone number of the resident.
- email – (optional) Registered email address of the resident.
Element: Pa (Optional)
This element captures attributes related to “Personal Address”. These are address fields as provided by the resident during enrolment or later updates. Only attributes that are sent as part of input will be compared.
Attributes:
- ms – (optional) “Matching Strategy” for address attributes. Currently only the value “E” (Exact) is supported. This is used only when at least one address attribute is specified.
- co – (optional) “Care of” person’s name.
- house – (optional) House identifier.
- street – (optional) Street name.
- lm – (optional) Landmark if any.
- loc – (optional) Locality where resident resides.
- vtc – (optional) Name of village or town or city.
- dist – (optional) District name.
- state – (optional) State name.
- pc – (optional) Postal pin code.
Element: Bios – (optional)
This element can have one or many “Bio” elements carrying biometric records to be matched.
Element: Bio (optional)
base 64 encoded biometric record
Attributes:
type – (optional) This attribute specifies type of the biometric. Valid values are “FMR” (Finger Minutiae), “FIR” (Finger Image), and “IIR” (Iris Image). Defaulted to “FMR”.
FMR – The biometric data is of type Fingerprint Minutiae Record. This
data is in ISO minutiae format with no proprietary extensions allowed. o FIR – The biometric data is of type Fingerprint Image Record. The data is a fingerprint image packaged in ISO 19794-4 format, which could contain a compressed or uncompressed image, of type PNG, WSQ, or Jpeg2000. o IIR – The biometric data is of type Iris Image Record. The data is an iris image packaged in ISO 19794-6 format, which could contain a compressed (or uncompressed) image, which could be of type PNG, or Jpeg2000.
Element value contains base-64 encoded biometric record.
Element: Pv (optional)
This element (“Pin Value”) is used to support additional secret “pin” or “otp” or both for supporting multi-factor authentication.
Attributes:
pin – (optional) Actual value of PIN as set by resident. This attribute contains a 6 digit numeric value.
otp – (optional) Most recently activated challenge-response OTP value for resident. Resident can send an SMS/Email to a specified short code or to specified email address to obtain an OTP and then use the last active OTP as part of authentication. This attribute contains a 6 digit numeric value. Unlike PIN, OTP is a one-time usage token.
Output Data Format
Authentication API does not provide any identity data as part of the response. All it does is to match given input and respond with a “yes/no”. Response XML is as follows:
<AuthResp ret=”y|n” code=”" txn=”" err=”"/>
Details
Element: AuthResp Attributes:
ret – this is the main authentication response. It is either “y” or “n”.
code – unique alphanumeric authentication response code having maximum length 40. AUA is expected to store this for future reference for handling any disputes. AADHAAR authentication server will retain authentication trail only for a short period of time as per UIDAI policy. After that period, older authentication trails will be deleted and this code will become unusable.
txn – Authenticator specific transaction identifier. This is exactly the same value that is sent within the request.
err – Failure error code. If authentication fails (“ret” attribute value is “n”), this attribute provides any of the following codes:
“100″ – “Pi” (basic) attributes of demographic data did not match.
“200″ – - “Pa” (address) attributes of demographic data did not match
“300″ – Biometric data did not match
“500″ – - Invalid encryption
“510″ – Invalid XML format
“520″ – Invalid device
“530″ – Invalid authenticator code
“540″ – - Invalid version
“550″ – Invalid “Uses” element attributes
“700″ – Invalid demographic data
“710″ – Missing “Pi” data as specified in “Uses”
“720″ – Missing “Pa” data as specified in “Uses”
“730″ – Missing PIN data as specified in “Uses”
“740″ – Missing OTP data as specified in “Uses”
“800″ – - Invalid biometric data
“810″ – Missing biometric data as specified in “Uses”
“999″ – - Unknown error
good
I am in Surat (Gujarat). Please send me the Aadhaar Appilacation Form. what i want to do first, please tell me and send the details.
my Contact number: 9099788716 – 7405165850
my email id: asvadseth@gmail.com – zorifseth@gmail.com
……….
in adharcard so many adreess and name spelling mistking from your workers…
from bidar (karanataka)
Aadhaar form which is downloaded from net is not accepted by the appointed agency. I stay @ Nagari Niwara Parishad zone 1&2, goregaon (E), mumbai 400065. Agency code no. 1218 (wipro Ltd) is appointed for this area. Application form on the net does not have agency code. Agency does not accept because they don’t get applied commission on such forms which are downloaded from net. Please look into the matter since people waste their time in standing in Q early morning
Cheers
Hemant Tukrul
sir,
i want uid card what is proceeser for get uid card, please tell us our nearest enroll centre
my residence Add- sonia vihar ,Delhi-92
i submit my adhar application last 26-04 -2011
i never receive adhar card
my enrolment no is 1190/10062/04189
please send me adhar card as fst as possible
thank you
aadhaar card…
I submited my details last four month but not received aadhar card and not aknowlage no.
so, please check stutas is very tough. Please check my details and send my above e mail id…
My Father’s Ration card No.- PAP 1583199 E 0310….
My Father’s Name :- Khoja Sadruddin S/o. Khoja Khamisha.
Address :- 2-4-46/V/107, Uppparpally, Happy Homes, Rajendranagar, R.R. Dist, Hyderabad-500 048.
Current Home Address :- Flat No.-201, Saara Arcade, Goutam Nagar, Upparpally, Rajendranagar, R.R.Dist, Hyderabad- 500 048….
So, Please any information send my above current home address…..
Thanking You…
Mansur Khoja..
I want to know that can we apply online application for uid.
Regards,
Puneet
डीटेल माहिती हवी आहे…………………..
iI HAVE NOT RECD M/Y UID THOUGH DONE AND PROCESSED BY YOUR STAFF IN FEBRUARY WHY SO
married
please send an application form to my id also give center details at bhopal m.p.
iam resident of raichur district and how to i get adhaar card what are the procedures for following
i want to adhaar camps in mumbai chembur vashi naka address & time
pls inform me
please send the aadhaar application form.
are a form word formet ma muko nilesh prajapati
Hi, I do not see any Enrollmant camps happening in Bangalore Urban..and all the agencies in the list either are not doing it now or not even into it. Let me know if you have the list of camps anywhere listed.
santosh jha
i need Aadhar Card
cont no.9030883871, 0863 2213322
please send me a aadhaar application form
Kindly let me know how to get the AAdhaar number authenticated.
i wnt aadhaar application form on my id including my family members
form
Hi, I would like to know from where I can get the form for UID.I am staying at Mohan Nagar,Ghaziabad (U.P.) 201007. I also wanted to know what are the requirments for getting UID and the nearest place where I can submit the form.
Thanks/Regards
Pl. send me the form
please send me adhar card application form in my e-mail-ID – sanjay10766@gmail.com
how& where to submit for aadhaar card
i want Aadhar application form can you pls sent me the aadhar form to my mail id
i want to Adhar application form
Hi,
So, the API can be used to know whether the inquired AADHAR id exists or not? No other information could be extracted from it?
If so, are there any future plans to extends API to provide other services as well?
Regards,
Rushi
aur bataye yah card kab tak banana hai
Last Date of this card
sir,
mera permanent address (village- Thasil) gav ka hai per mai sahar me (District) kam karta hu to kya me aadhaar card sahar (District) me nikal sakta hu kya
i am vikas kumar sharma from rajasthan, i would like to know where i will ahve to apply for AADHAAR AUTHENTICATION application form in RAJASTHAN,
CON: 9351720787,9772146942,
PLEASE GUIDE ME TO GET THE APPLICATION FORM AND OTHER PROCEDURE BECAUSE I DON’T WANT TO MISS THIS CHANCE TO GET THE UIN. NO
I am prashant Patil. I required four form for my Family.
Dear Sir,
As per your reference every person is must to go for the Enrollment to the Aadhaar centre. If any person unable to go to the Aadhaar Centre because of illness, paralysis, or any critical dieases. please give me the solution. What is the process for that person?
dear sir ma h.no 1-42-61 nazarpet teanli. guntur (d.t) ap. sir maku aadher card photo thesaru kani card raledu ma father ki vachinadi card eapudu eami cheyali
sss
plese send aadhar application fom
please send me a aadhar application form,on my mail id urgently.
thanks your all team.
Sir/Madam,
I am very much eager to know about iaadhaar & interest to register my self.
Kindly let me know about were to get Application form & the address to, as
I am staying in Chembur, Mumbai- 400071.
One very informative site about UID/Aadhaar card is
http://www.uidcards.org
Thanks
Rahul
Attributes:
ms – (optional) “Matching Strategy” for “name” attribute. Currently only the value “E” (Exact) is supported. This is used only when “name” attribute is specified. Future releases will support fuzzy matching.
name – (optional) Name of the resident.
gender – (optional) Valid values are “M” for male, “F” for female, and “T” for transgender.
dob – (optional) Date of Birth in “YYYY-MM-DD” format. If only year needs to be authenticated, then use format “YYYY”.
phone – (optional) Registered mobile phone number of the resident.
email – (optional) Registered email address of the resident.
Element: Pa (Optional)
This element captures attributes related to “Personal Address”. These are address fields as provided by the resident during enrolment or later updates. Only attributes that are sent as part of input will be compared.
Attributes:
ms – (optional) “Matching Strategy” for address attributes. Currently only the value “E” (Exact) is supported. This is used only when at least one address attribute is specified.
co – (optional) “Care of” person’s name.
house – (optional) House identifier.
street – (optional) Street name.
lm – (optional) Landmark if any.
loc – (optional) Locality where resident resides.
vtc – (optional) Name of village or town or city.
dist – (optional) District name.
state – (optional) State name.
pc – (optional) Postal pin code.
Element: Bios – (optional)
This element can have one or many “Bio” elements carrying biometric records to be matched.
Element: Bio (optional)
base 64 encoded biometric record
Attributes:
type – (optional) This attribute specifies type of the biometric. Valid values are “FMR” (Finger Minutiae), “FIR” (Finger Image), and “IIR” (Iris Image). Defaulted to “FMR”.
FMR – The biometric data is of type Fingerprint Minutiae Record. This
data is in ISO minutiae format with no proprietary extensions allowed. o FIR – The biometric data is of type Fingerprint Image Record. The data is a fingerprint image packaged in ISO 19794-4 format, which could contain a compressed or uncompressed image, of type PNG, WSQ, or Jpeg2000. o IIR – The biometric data is of type Iris Image Record. The data is an iris image packaged in ISO 19794-6 format, which could contain a compressed (or uncompressed) image, which could be of type PNG, or Jpeg2000.
Element value contains base-64 encoded biometric record.
Element: Pv (optional)
This element (“Pin Value”) is used to support additional secret “pin” or “otp” or both for supporting multi-factor authentication.
Attributes:
pin – (optional) Actual value of PIN as set by resident. This attribute contains a 6 digit numeric value.
otp – (optional) Most recently activated challenge-response OTP value for resident. Resident can send an SMS/Email to a specified short code or to specified email address to obtain an OTP and then use the last active OTP as part of authentication. This attribute contains a 6 digit numeric value. Unlike PIN, OTP is a one-time usage token.
Output Data Format
Authentication API does not provide any identity data as part of the response. All it does is to match given input and respond with a “yes/no”. Response XML is as follows:
Details
Element: AuthResp Attributes:
ret – this is the main authentication response. It is either “y” or “n”.
code – unique alphanumeric authentication response code having maximum length 40. AUA is expected to store this for future reference for handling any disputes. AADHAAR authentication server will retain authentication trail only for a short period of time as per UIDAI policy. After that period, older authentication trails will be deleted and this code will become unusable.
txn – Authenticator specific transaction identifier. This is exactly the same value that is sent within the request.
err – Failure error code. If authentication fails (“ret” attribute value is “n”), this attribute provides any of the following codes:
“100″ – “Pi” (basic) attributes of demographic data did not match.
“200″ – – “Pa” (address) attributes of demographic data did not match
“300″ – Biometric data did not match
“500″ – – Invalid encryption
“510″ – Invalid XML format
“520″ – Invalid device
“530″ – Invalid authenticator code
“540″ – – Invalid version
“550″ – Invalid “Uses” element attributes
“700″ – Invalid demographic data
“710″ – Missing “Pi” data as specified in “Uses”
“720″ – Missing “Pa” data as specified in “Uses”
“730″ – Missing PIN data as specified in “Uses”
“740″ – Missing OTP data as specified in “Uses”
“800″ – – Invalid biometric data
“810″ – Missing biometric data as specified in “Uses”
“999″ – – Unknown error
Attributes:
pi – (mandatory) Valid values are “y” or “n”. If the value is “y” then at least one attribute of element “Pi” (part of “Demo” element) should be used in authentication. Otherwise, it is not mandated.
pa – (mandatory) Valid values are “y” or “n”. If the value is “y” then at least one attribute of element “Pa” (part of “Demo” element) should be used in authentication. Otherwise, it is not mandated.
bio – (mandatory) Valid values are “y” or “n”. If the value is “y” then at least one biometric element “Bio” (part of “Bios” element) should be used in authentication. Otherwise, it is not mandated.
bt – (mandatory only if “bio” attribute has value “y”) provide a comma separated list of biometrics used. Valid values that can be used in this comma separated list are “FMR”, “FIR”, and “IIR”. If “FMR” is part of the list, then at least one “Bio” element with type FMR should be used. Similarly, if “FIR” or “IIR” are part of the list, then at least one “Bio” element with those types must be used.
pin – (mandatory) Valid values are “y” or “n”. If the value is “y” then PIN should be used in authentication. Otherwise, “pin” is not mandated.
otp – (mandatory) Valid values are “y” or “n”. If the value is “y” then OTP should be used in authentication. Otherwise, “otp” is not mandated.
Element: Skey (mandatory only for Public devices)
Value of this element is base-64 encoded value of encrypted session key. See next chapter for encryption details.
Element: Pid (mandatory)
Attributes:
ts – (mandatory) Timestamp at the time of demographic and biometric input capture. This is in ISO 8601 date and time format “YYYY-MM-DDThh:mm:ss”. Time zone automatically defaulted to IST (UTC +5.30).
AUAs can queue authentication requests and send it to AADHAAR authentication server to support occasional lack of network connectivity on the field. Maximum time up to which requests can be queued will be defined by UIDAI policy. During initial release, this will be configured to 24 hours. All requests with “ts” value older than this limit will be rejected.
Element: Demo (optional)
Contains child elements “Pi” and “Pa” both of which are optional.
All demographic data fields as per KYR specifications.
Element: Pi (Optional)
This element captures attributes related to “Personal Identity”
Why you copy this content from Official Document ? They will not happy when know about this website.
Which class of degital certificate has to be procured by the registrar? class 2 or class 3?
Hi
I had heard about Aadhar from my neighbour. Pls clear me the motive & concept of Aadhar.
I am resident of India & citizen above poverty line. Do I required to enroll for same. If yes please let me know nearest centre for enrollment as I stay at Ulhasnagar- Dist – Thane, Maharashtra.
thanks