apyhub-logo
5 atoms
Base tier

About

This API lets you validate 12-digit Aadhar numbers.
Aadhaar number is a 12-digit unique identity number given by the Indian Administration to residents of India. The Aadhar number validation is a crucial part in the process for verifying an individual's identity in applications that require it, such as e-KYC, online banking, and e-commerce.
Try out the API in the API playground and see how the free Aadhar Number Validation API can help you validate Aadhar numbers with a simple API call.

API Playground

API Documentation

validate Aadhaar
POST
https://api.apyhub.com/validate/aadhaar

Request example

1
curl --location --request POST 'https://api.apyhub.com/validate/aadhaar' \
2
--header 'apy-token: {{token}}' \
3
--header 'Content-Type: application/json' \
4
--data '{
5
"aadhaar":"568095330001"
6
}'
Method: POST
Content Type: application/json
Request Body
AttributeTypeMandatoryDescription
aadhaarstringYesThe Aadhaar number that you want to validate. for example: 568095330001
Sample Response
A successful request returns the data: true if the number is valid. If its not not then it will simply returns data: false

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
400Invalid input.
401Required authentication information is either missing or not valid for the resource.
500If any unexpected error occurs while processing the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
"error": {
3
"code": 105,
4
"message": "Invalid URL"
5
}
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.