Passport Verification API
Confirm an Indian passport application by its file number and the holder’s date of birth, and match the name, in one call.
The documentation opens in the VerifyAll dashboard after sign-in, for accounts with approved API access. New to the API? Start with the developer guide.
Overview
What the Passport Verification API does
The Passport Verification API checks an Indian passport by its application file number, not the passport number printed on the booklet. You send the 15-character file number (two letters and 13 digits) with the holder’s date of birth, and the API answers with the application on record: the full name with given name and surname, the date of birth, whether the date you sent matches, the application type (normal or tatkaal) and the date the application was received.
The file number and date of birth are used together to find the application, so a file number paired with the wrong date of birth does not return someone else’s details. Send the name your customer gave as well and name_match compares it with the name on the application, with a score from 0 to 100.
A passport is the identity document many salaried, high-value and frequently travelling customers prefer to give. Verifying the application behind it, instead of a scanned copy, gives your KYC or hiring file a stored, checkable result.
How it works
- 1
Your server sends POST /universal/passport-verification with the file number, the date of birth, the consent object and, if you have it, the name to compare.
- 2
The request is checked first: a file number that is not two letters and 13 digits, a malformed date or a missing consent object is refused with every problem listed before anything runs or is charged.
- 3
The file number and date of birth are checked against live records together, and the answer comes back in the same call, usually within about 5 seconds.
- 4
The result is stored in your VerifyAll account with a checkResultId, which you can read again, find by your client_ref or download as a PDF report.
Request and response
Passport verification API endpoints and fields
The main fields; the full reference with every field, error code and a cURL sample is in the dashboard docs.
| Endpoint | What it does |
|---|---|
| POST/universal/passport-verification | Verify a passport by file number and date of birth |
Request fields
| Field | What it is |
|---|---|
| file_numberRequired | The passport application file number: 2 letters and 13 digits (for example XY0001112223334). This is not the passport number. |
| dobRequired | The holder’s date of birth, YYYY-MM-DD; used with the file number to find the application. |
| consentRequired | obtained: true and a purpose of up to 200 characters, for the passport holder. |
| nameOptional | The name your customer gave; sets name_match. |
| client_refOptional | Your own reference, stored with the result (up to 100 characters). |
What the answer returns
| Field | What it is |
|---|---|
| file_number | The application file number that was checked. |
| name / given_name / surname | The full name on the application, and its given name and surname. |
| name_match | exact, partial, mismatch or not_checked, with a score from 0 to 100. |
| dob / dob_match | Date of birth on record, and whether the one you sent equals it. |
| application_type | normal or tatkaal, in lower case. |
| application_received_on | When the application was received, YYYY-MM-DD. |
Base URL https://api.verifyall.ai. Authenticate with the X-API-Key header (a va_sandbox_ or va_live_ key). Every answer carries data, status_code, success, message and message_code; checks add outcome, checkResultId, charged and charged_amount.
Key features
Passport Verification API features and capabilities
Two keys, not one
The application is found by file number and date of birth together, which keeps a guessed or mistyped file number from returning a stranger’s details.
Given name and surname split
The answer separates given_name and surname as well as the full name, so you can map them straight into forms that hold them apart.
Name and date-of-birth match
name_match with a 0–100 score and a dob_match flag tell you at once whether the person in front of you is the applicant.
Stored result and PDF
Every completed check is kept with a checkResultId and a PDF report that you can attach to a KYC or background file.
Use cases
Where businesses use the Passport Verification API
NRI and premium account opening
Verify the passport of customers who use it as their main identity document, at account opening or a change of details.
Hiring and background checks
Confirm a candidate’s passport details, especially for roles involving travel or overseas postings.
Travel and visa services
Check that the passport details a traveller gives match an application on record before you book or file on their behalf.
High-value insurance and investment KYC
Match the name and date of birth of a policyholder or investor to their passport application.
Industries
Coverage
Indian passports, found by the application file number and the holder’s date of birth. Passports issued by other countries are not covered.
Limitations to plan for
- The API needs the application file number. It cannot look a passport up by the passport number printed on the booklet.
- The answer describes the application: name, date of birth, application type and date received. It does not return passport issue or expiry dates.
- A file number and date of birth with no matching application answer record_not_found. The lookup ran, so it is charged like any completed check.
- Checks about a person need the consent object, and you keep the consent record.
Integration
How to integrate the Passport Verification API
From a business account to your first live call.
Step 1
Create a business account on VerifyAll and get it approved, as for running checks in the dashboard.
Step 2
Request Developer API access under Developers in the dashboard: the APIs you need, your expected monthly volume and your use case. The VerifyAll team reviews it and shares the API Services Agreement.
Step 3
Once the agreement is signed and access is approved, create your Sandbox key and build against sample data. Sandbox calls are never charged.
Step 4
Create your Production key, recharge your wallet and switch the key in your code: the endpoint and fields stay the same.
Get started
Request access to the Passport Verification API
Tell us what you want to verify. We reply within one business day with access steps, Sandbox details and your API pricing.
View API documentation
The full reference for Passport Verification API (endpoints, fields, errors, cURL) opens in the dashboard once your access is approved.
Open the docs (sign-in)Create a business account
API keys are issued to an approved business account. Sign up, then request access under Developers.
Create account
Pricing
Production calls are charged per check from your prepaid VerifyAll wallet, at your account’s API price; GST is added separately when you recharge. Sandbox calls are never charged. Your API prices are shown in the dashboard once access is approved. How pricing works
Already have a business account? Sign in to request access
Passport Verification API: frequently asked questions
Answers for teams planning an integration.
Still have questions? Our team is happy to help.
Contact SupportRelated APIs
PAN Verification API
LiveInstant answerConfirm a PAN exists, see who holds it and match the name and date of birth your customer typed, in one call.
View API detailsVoter ID Verification API
LiveInstant answerConfirm a voter ID card is genuine and see the name, relative, age and address on record, in one call.
View API detailsAML Screening API
LiveInstant answerScreen a person or an entity against sanctions, enforcement and regulatory watch lists and adverse media in one call, with every hit scored.
View API detailsBackground Verification API
LiveFinishes laterRun the background checks you choose on one person in a single request, and read back one report with an overall result and every check’s outcome.
View API details
All identity verification APIsRun Passport verification in the dashboard, without codeBrowse the API Marketplace
Start with the Passport Verification API
Request access, build against the Sandbox, then go live with your Production key.