Possible Aadhar Error

API Error Handling | Developer Portal
1 of 12
https://developer.uidai.gov.in/site/node/39
Developer Portal
Home Aadhaar Authentication Basics
API Error Handling

This page provides guidelines for handling API errors within the application. While developing applications, AUAs need to
decide how to handle the errors gracefully and provide resident/operator friendly messages. Simply showing the error on
screen is not helpful. This document is an attempt to provide guidelines for doing better error handling.
Follwing table desribes API error codes, suggestion for how to handle it, possible message to user, and probable reasons
for the error.
API
Error
Description
Code
100
Provision
Suggested
Suggested
Required in the
Message to the
instructions to
Application
User
the user
Probable Reasons
Pi (basic)
User should be
Please re-enter
Operator should
One or more personal
attributes of
allowed to re- enter
your <name,
re-enter correct
information attributes
demographic data
his/her personal
lname, gender,
details personal
not matching.
did not match
information
dob, dobt, age,
information as per
attributes like name,
phone, email>.
the Aadhaar letter.
lname, gender, dob,

dobt, age, phone,
email whichever is
Ensure correct
used for
Aadhaar
authentication in
Information is
application
200
entered.
Pa (address)
User should be
Please re-enter
Operator should
One or more personal
attributes of
allowed to re- enter
your <co (care
re-enter correct
address attributes not
demographic data
his/her personal
of), house, street,
details personal
matching.
did not match
address attribute
lm (land mark),
information as per
like co (care of),
loc (locality), vtc,
the Aadhaar letter.
house, street, lm
subdist, dist,
(land mark), loc
state, pc (postal
(locality), vtc,
pin code), po (post
subdist, dist, state,
office)>.
pc (postal pin code),
Ensure correct
Aadhaar
Information is
po (post office)
entered.
whichever is used for

authentication in
application
300
Biometric data did
User should be
Please give your
Ensure correct
Finger print is not
not match
allowed to give his
finger prints
Aadhaar number is
given properly,
finger prints n
again.
entered and try
scanner has some
number of times. N
authenticating
dust accumulated,
should be
again with another
fingers were wet,
configurable and
finger; ensure
position of finger not
1/14/2016 9:34 PM
2 of 12
should be set as per
finger is placed
appropriate, scanned
application
correctly; ensure
finger NFIQ not good
requirement. (E.g.
fingers are clean;
For Banking
ensure finger is not
Applications it can be
very dry; ensure
set at a maximum of
fingerprint scanner
5 times)
is clean.
After repeated
failure, if the
resident is
genuine, exception
handling provision
would need to be
followed to provide
service.
Please contact
UIDAI helpdesk to
inform about the
issue and to
understand the
steps for the
updation of the
biometric
information in
CIDR.
310
Duplicate fingers
Application should
Please try again
Operator should
Error occurs when
used
prompt user to try
with distinct
insure that the
same finger is sent as
again with distinct
fingers.
resident is
two or more separate
providing distinct
records within same
fingers (two
request. For
different fingers)
two-finger auth, if
for two finger
resident puts same
authentication.
finger again, then this
fingers.
happens.
311
Duplicate Irises
Application should
Please try again
Operator should
Error occurs when
used
prompt user to try
with distinct irises.
ensure that the
same iris is sent as
again with distinct
resident is
two or more separate
irises.
providing distinct
records within same
irises (two
request.
different irises) for

authentication.
312
FMR and FIR cannot
Application should
Technical
Contact technical
be used in same
ensure that
Exception <No>
helpdesk.
transaction
authentication
"image" records (FIR)
request does not mix
and fingerprint
FMR and FIR in the
"minutiae" records
same transaction
(FMR). AUA app
Auth packet cannot

mix fingerprint
1/14/2016 9:34 PM
3 of 12
e.g. in case of two
should choose either
finger
one or another. FMR
authentication, data
is recommended.
for two distinct

fingers should either
be sent in FMR
format or in FIR
format.
313
Single FIR record
Application should
Please try again
Operator should
As per ISO spec, one
contains more than
prompt user to try
by placing Single
ensure that the
FIR can contain one
one finger
again by placing
finger on the
resident is
or more finger
single finger.
authentication
providing single
images within itself
device.
finger for
(like slap, etc). UIDAI
authentication.
currently supports
single finger record
only. If there is a
requirement to send
2 fingers, 2 different
biometric records
should be sent.
314
Number of FMR/FIR
Application should
Auth Request has
should not exceed
ensure that one auth
more than 10 finger
10
request should not
records
contain more than

10 FMR/FIR records.
315
Number of IIR
Application should
Auth Request has
should not exceed 2
ensure that one auth
more than 2 iris
request should not
records
contain more than 2

IIR records.
400
"OTP" validation
Application should
Please provide
If there are
Incorrect OTP value
failed
have provision for
correct OTP value.
repeated failures
is entered. Input not
allowing user to
user is advised to
matching with the
provide OTP value
generate new OTP
value in CIDR.
again and after
and send the
some retries
authentication
(configurable) option
request using the
to generate OTP
new OTP.
again.
401
"Tkn" validation
Application should
Provided "Tkn
failed
derive the value of
details are not
tkn (currently only
matching with
mobile number)
registered values in
from network. This
CIDR.
element is meant for

self-service
transations on
mobile (SMS/USSD,
etc) where AUA
derives the mobile
number from the
network provider
and passes it on as
1/14/2016 9:34 PM
4 of 12
part of API to use it

as a factor.
500
Invalid
Application should
Technical
Contact technical
Use of wrong digital
Skeyencryption
not have hard coded
Exception <No>
helpdesk.
certificate for
digital certificate
information. It
encryption of
Note: Application
should be
can throw Auth
configurable.
API error code
AES-256 Key (session

key).
number on screen.
So that contact
centre or
application
support helpline
can understand
the reason.
501
Invalid value for
Application should
Technical
Ensure that expiry
ci attribute in
not have hard coded
Exception <>
date of UIDAI
Skey element
ci attribute value.
certificate used for
It should be
encryption of Skey is
configurable.
specified as ci
value.
502
Invalid Pid
Application should do
Technical
Ensure that correct
Encryption
extensive testing
Exception <No>
AES encryption has

been used.
using UIDAI Test

Auth Service to
ensure compliance
Ensure that AES key
with auth API.
used for encryption of

Pid XML was
encrypted and
specified as value for
Skey.
503
Invalid HMac
Application should do
Technical
Ensure that correct
encryption
extensive testing
Exception <No>
AES encryption has
using UIDAI Test
been used.
Auth Service to
Ensure that AES key
ensure compliance
used for encryption of
with auth API.
Hmac was
encrypted and
specified as value for
Skey.
Ensure that same
AES key is used for
encryption of Pid and
Hmac.
504
Session key
Application should
Technical
re-initiation
have a provision to
Exception <No>
required due to
send full session key
is used, this can
expiry or key out of
and initiate a new
happen if either
Please try again.
When Synchronized
Session Key scheme
1/14/2016 9:34 PM
5 of 12
sync
session in case of
session is expired
such failure.
(currently configured
to max 4 hrs) or if the
key goes out of sync.
505
Synchronized Skey
Application should
Technical
Switch to full skey
This happens when
usage is not
use full skey
Exception <No>
scheme
AUA does not have
allowed
privilage to use SSK

scheme
510
Invalid Auth XML
Application
Technical
Please ensure that
Non compliance with
format
Authentication
Exception <No>
the latest
supported
request should
recommended API
Authentication API
comply to
is used for
version structure in
Authentication API
application
CIDR.
latest version and
development.
application should
Refer UIDAI
validate its structure
website for the
before sending it to
latest version of
CIDR for
API.
authentication.
If this does not
resolve the issue
than please
contact technical
helpdesk.
511
Invalid PID XML
Application
Technical
Please ensure that
Non compliance with
format
Authentication
Exception <No>
the latest
supported
request should
recommended API
Authentication API
comply to PID XML
is used for
version structure in
format defined in
application
CIDR.
Authentication API
development.
latest version and
Refer UIDAI
structural validation
website for the
should be done
latest version of
before encryption of
API.
PID XML.
If this does not
resolve the issue
than please
contact technical
helpdesk.
520
Invalid device
Application should
Technical
Using any other value
ensure that tid
Exception <No>
other than public
attribute in Auth XML
(all lower case, no
has value public
spaces or special
char) will result in
this error.
521
Invalid Finger
Application should
device (fdc in Meta
obtain proper code
element)
from fingerprint
certification and
sensor vendor and
application developer
use it
should use proper fdc
Technical
Exception <No>
FDC codes are

assigned as part of
1/14/2016 9:34 PM
6 of 12
code given by the

fingerprint
sensor/extractor
vendor
522
Invalid Iris device
Application should
IDC codes are
(idc in Meta
obtain proper code
element)
from iris sensor
certification and
vendor and use it
application developer
Technical
assigned as part of
Exception <No>
should use proper idc

code given by the iris
sensor/extractor
vendor
530
Invalid
Application should
Technical
AUA code used in
authenticator code
pass valid AUA code
Exception <No>
Authentication
in authentication
request is not valid.
request which is
or
registered with
UIDAI. Value of this
AUA code used in the
code should be
Auth URL is not same
configurable.
as the AUA code used

in the Auth XML.
540
Invalid Auth XML
Application should
Technical
API version used in
version
pass supported valid
Exception <No>
Auth XML
API version in
(Authentication
authentication
request) is either not
request. Value of this
supported or invalid.
should be
configurable.
541
Invalid PID XML
Application should
Technical
Version of the Pid
version
pass supported valid
Exception <No>
element used
API PID XML version

In the PID XML
in authentication
542
request. Value of this
(Authentication
should be
request) is either not
configurable.
supported or invalid.
AUA not authorized
Application should
Ensure the
This error will be
for ASA.
ensure link is in
authentication
returned if AUA and
place between
request is being
ASA do not have
AUA-ASA before
sent through the
linking in the portal
sending request to
authorized ASA as
CIDR.
per the records of

UIDAI.
or
Please contact
UIDAI helpdesk to
report the issue
and to understand
further steps for
1/14/2016 9:34 PM
7 of 12
the updation of
ASA-AUA linkage.
543
Sub-AUA not
Application should
Ensure the
This error will be
associated with
ensure Sub-AUA is
authentication
returned if Sub-AUA
AUA
added and
request is being
specified in sa
associated with
sent through the
attribute is not added
correct AUA before
associated AUA as
as Sub-AUA in
sending request to
per the records of
portal
CIDR.
UIDAI.
or
Please contact
UIDAI helpdesk to
report the issue
and to understand
further steps for
the updation of
ASA-AUA linkage.
550
Invalid Uses
Application should
Technical
Invalid attributes
element attributes
use valid attributes
Exception <No>
used in Uses tag.
defined in API for

<Uses> tag and
This error is typically
validation on Auth
reported if bt
attribute has been
request should be
done before sending
specified but bio=n
request to CIDR.
in Uses element. bt
attribute is required
only if bio=y in
Uses element.
561
Request expired
AUA application
1.
(Pid->ts value is
should not store Pid
Device/Client
In case of
the device/client
/Server date/time is
older than N hours
block and in case of
based Application
date/time is
behind current one or
where N is a
application which are
synchronised with
old stored pid is
configured
using thick client
a.
Indian Standard
getting sent.
threshold in
there should be a
device date/time
authentication
provision to sync up
server)
date with server at
date/time or
authentication
start.
request is old.
request.
Either
is behind current
Please verify that
Either Device/Client
Time (IST) and

resend the
Please try again.

2.
In case of
web based
Application
a.
Technical
Exception <No>
562
Timestamp value is
AUA application
1.
Please verify that
Device/Client/server
future time (value
should not store Pid
Device/Client
the device/client
date/time is ahead
specified Pid->ts
block and in case of
based Application
date/time is
than current
is ahead of
application which are
synchronised with
date/time.
a.
In case of
Either
1/14/2016 9:34 PM
8 of 12
authentication
using thick client
device date/time
Indian Standard
server time beyond
there should be a
is ahead current
Time (IST) and
acceptable
provision to sync up
date/time or
resend the
threshold)
date with server at
request is old.
authentication
start.
Please try again.
request.
2.
In case of
web based
Application
a.
Technical
Exception <No>
563
Duplicate request
Application should
Please submit
User is required to
If same Auth XML is
(this error occurs
ask user to try
your request
send the
sent more than once
when exactly same
again.
again.
authentication
to server, then, 2nd
authentication
request once
and subsequent
request was re-sent
again.
requests will fail with
by AUA)
564
this error.
HMAC Validation
Application should
Technical
failed
create HMAC using
Exception <No>
calculated using API

defined algorithm
SHA-256
565
HMAC is not
License key has
Application should
Technical
Current License has
expired
have a configurable
Exception <No>
expired.
Application should
Technical
License key used in
have a License key
Exception <No>
application is invalid.
License key
management feature
through which one
can manage Key
without changing
application.
566
Invalid license key
management feature
through which one
can manage Key
without changing
application.
567
Invalid input (this
Application should
Technical
some unsupported
error occurs when
have client/server
Exception <No>
characters were
some unsupported
level checks to stop
found in Indian
characters were
users to input
language values,
found in Indian
unsupported
lname or lav in
language values,
characters.
Auth request XML
lname or lav)
568
Unsupported
Application should
Technical
Value of lang
Language
have client/server
Exception <No>
attribute is not from
level checks to
the list supported by
1/14/2016 9:34 PM
9 of 12
restrict users to only
authapi.
select language from

API supported local
Language.
569
Digital signature
Application should
Technical
Authentication
verification failed
ensure security of
Exception <No>
request XML was
(this means that
data end to end ie.
modified after it was
authentication
From client/device to
signed.
request XML was
CIDR server by
modified after it
using appropriate
was signed)
communication
protocol.
570
Invalid key info in
Application should
Technical
Certificate used for
digital signature
have an independent
Exception <No>
signing the
(this means that
module for signing
authentication
certificate used for
Auth XML and
request is not valid
signing the
certificate should be
it is either expired, or
authentication
stored and manage
does not belong to
request is not valid
outside of the
the AUA or is not
it is either
application.
created by a
expired, or does
well-known
not belong to the
Certification Authority
AUA or is not
created by a
well-known
Certification
Authority)
571
PIN Requires reset
Please reset your
Please change
This error will be
(this error will be
PIN in UIDAI
your default PIN
returned if resident is
returned if resident
updation
through UIDAI
using the default PIN
is using the default
application and
updation client and
which needs to be
PIN which needs to
use new PIN in
resend your
reset before usage.
be reset before
this application.
authentication
request.
usage)
572
Invalid biometric
Application should
Technical
This error is returned
position (This error
have client level
Exception <no>
if biometric position
is returned if
validation to check
value - pos
biometric position
type and
attribute in Bio
value - pos
corresponding valid
element - is not
attribute in Bio
pos values before
applicable for a given
element - is not
creating PID block.
biometric type -
applicable for a
type attribute in
given biometric
Bio element
type - type
attribute in Bio
element.)
573
Pi usage not
Application should
Technical
Pi usage not allowed
allowed as per
have a configurable
Exception <No>
as per license
1/14/2016 9:34 PM
10 of 12
license
business rule which

can restrict the
usage of Pi attribute
based on AUA license
authorization.
574
Pa usage not
Application can have
Technical
Pa usage not allowed
allowed as per
a client level check
Exception <No>
as per license
license
to restrict/allow
entry of pa
attribute as per
license of AUA.
575
Pfa usage not
Technical
Pfa usage not allowed
allowed as per
Exception <No>
as per license
license
to restrict/allow
entry of pfa
attribute as per
license of AUA.
576
FMR usage not
Technical
FMR usage not
allowed as per
Exception <No>
allowed as per license
license
to restrict/allow
entry of FMR
attribute as per
license of AUA.
577
FIR usage not
Technical
FIR usage not
allowed as per
Exception <No>
license
to restrict/allow
entry of FIR
attribute as per
license of AUA.
578
IIR usage not
Technical
IIR usage not allowed
allowed as per
Exception <No>
as per license
license
to restrict/allow
entry of IIR
attribute as per
license of AUA.
579
OTP usage not
Technical
OTP usage not
allowed as per
Exception <No>
license
to restrict/allow
entry of OTP
attribute as per
license of AUA.
580
PIN usage not
Technical
PIN usage not
allowed as per
Exception <No>
license
to restrict/allow
entry of PIN
1/14/2016 9:34 PM
11 of 12
attribute as per
license of AUA.
581
Fuzzy matching
Technical
Fuzzy matching usage
usage not allowed
Exception <No>
not allowed as per
as per license
to restrict/allow
license
entry of ms
attribute in pi, pa
and pfa element as
per license of AUA.
582
Local language
Technical
Local language usage
usage not allowed
Exception <No>
not allowed as per
as per license
to restrict/allow
license
entry of local
language attribute in
pi, pa and pfa
element as per
license of AUA.
584
Invalid Pin code in
Pincode should have
Technical
If pincode value is
Meta element
a valid value (in lov
Exception <No>
not one of the valid

values in UIDAI
attribute)
system, this error

occurs
585
Invalid Geo code in
Geo code value must
Meta element
be a valid lat.long
Technical
Exception <No>
If geo code does not

have proper format
value in decimal
as per spec (decimal
format as per spec
representation with
(in lov attribute)
porecision upto 4
decimal values for lat
and long), this error
occurs
710
Missing Pi data as
Application should
Technical
Missing Pi data as
specified in Uses
validate pid block
Exception <No>
specified in Uses
Technical
Missing Pa data as
Exception <No>
specified in Uses
before encrypting
data with API
specified PID block
structure and Uses
element attributes
values to ensure PID
block have all the
elements and
attributes. Client
level validation
should also be put to
check all mandatory
and conditional fields
of API XML.
720
Missing Pa data as
specified in Uses
Same as 710
1/14/2016 9:34 PM
12 of 12
Developing in C/C++
up
Printer-friendly version
| Copyright 2010 UIDAI All Rights Reserved | Terms of Use | Privacy Policy | Disclaimer |
1/14/2016 9:34 PM

Possible Aadhar Error

Caricato da

Informazioni sul documento

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

Possible Aadhar Error

Caricato da

Copyright:

Formati disponibili

API Error Handling | Developer Portal

API Error Handling

One or more personal

allowed to re- enter

did not match

dob, dobt, age,

attributes like name,

the Aadhaar letter.

lname, gender, dob,

One or more personal

allowed to re- enter

your <co (care

address attributes not

of), house, street,

did not match

like co (care of),

loc (locality), vtc,

the Aadhaar letter.

(land mark), loc

pin code), po (post

subdist, dist, state,

pc (postal pin code),

whichever is used for

Biometric data did

Please give your

Finger print is not

allowed to give his

entered and try

scanner has some

again with another

fingers were wet,

position of finger not

API Error Handling | Developer Portal

should be set as per

finger NFIQ not good

fingers are clean;

ensure finger is not

very dry; ensure

Please try again

Error occurs when

prompt user to try

insure that the

same finger is sent as

again with distinct

two or more separate

records within same

for two finger

resident puts same

finger again, then this

Please try again

Error occurs when

prompt user to try

with distinct irises.

ensure that the

same iris is sent as

again with distinct

two or more separate

records within same

different irises) for

FMR and FIR cannot

"image" records (FIR)

request does not mix

FMR and FIR in the

(FMR). AUA app