India

Aadhaar Card

The following API triggers the SMS message with the OTP code to the registered mobile number associated to the card

post

Government database lookup API

Header parameters

AuthorizationstringRequired

Bearer token

Body

application/json

documentNumberstring · min: 1Required

Responses

200

OK

application/json

requestIdstringOptional

400

Bad Request: Missing required input or invalid format

application/json

401

Unauthorized: No valid access token has been provided

403

Forbidden: Access token doesn't have permission to use the requested feature

429

Too Many Requests

500

Internal Server Error: Unexpected error

503

Service unavailable: Government database not available

post

/api/v2/id/lookup/ind/id/otp

HTTPcURLJavaScriptPython

POST /api/v2/id/lookup/ind/id/otp HTTP/1.1
Host: id.uqudo.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "documentNumber": "text"
}

{
  "requestId": "text"
}

Use the OTP code to perform the actual lookup

post

Government database lookup API

Header parameters

AuthorizationstringRequired

Bearer token

Body

application/json

otpstring · min: 1Required

documentNumberstring · min: 1Required

requestIdstring · min: 1Required

Responses

200

OK

application/json

faceImagestringOptional

Base64 encoded face image of the user

fullNamestringOptional

dateOfBirthstringOptional

dateOfBirthFormattedstringOptional

ISO-8601 format yyyy-MM-dd

genderstringOptional

addressstringOptional

documentNumberstringOptional

fatherNamestringOptional

husbandNamestringOptional

relativeNamestringOptional

400

Bad Request: Missing required input or invalid format

application/json

401

Unauthorized: No valid access token has been provided

403

Forbidden: Access token doesn't have permission to use the requested feature

429

Too Many Requests

500

Internal Server Error: Unexpected error

503

Service unavailable: Government database not available

post

/api/v2/id/lookup/ind/id

HTTPcURLJavaScriptPython

POST /api/v2/id/lookup/ind/id HTTP/1.1
Host: id.uqudo.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "otp": "text",
  "documentNumber": "text",
  "requestId": "text"
}

{
  "faceImage": "text",
  "fullName": "text",
  "dateOfBirth": "text",
  "dateOfBirthFormatted": "text",
  "gender": "text",
  "address": "text",
  "documentNumber": "text",
  "fatherName": "text",
  "husbandName": "text",
  "relativeName": "text"
}

PAN card

post

Government database lookup API

Header parameters

AuthorizationstringRequired

Bearer token

Body

application/json

documentNumberstring · min: 1Required

Responses

200

OK

application/json

fullNamestringOptional

documentNumberstringOptional

fatherNamestringOptional

400

Bad Request: Missing required input or invalid format

application/json

401

Unauthorized: No valid access token has been provided

403

Forbidden: Access token doesn't have permission to use the requested feature

429

Too Many Requests

500

Internal Server Error: Unexpected error

503

Service unavailable: Government database not available

post

/api/v2/id/lookup/ind/pan

HTTPcURLJavaScriptPython

POST /api/v2/id/lookup/ind/pan HTTP/1.1
Host: id.uqudo.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "documentNumber": "text"
}

{
  "fullName": "text",
  "documentNumber": "text",
  "fatherName": "text"
}