Verification API
Introduction
This API helps to verify Passport of any indian citizen by giving the File Number, name and Date of Birth, as input.
How to call the API
You will need to login before sending the request. You are required to pass the access token received from the login call, as authorization header in the Verification API request.
API Input Guidelines
- For verification of Passport details, card fileNumber, dob and name on card are mandatory.
Sample Curl
curl --location --request POST 'https://signzy.tech/api/v2/patrons/<patron ID>/passportV2' \
--header 'Authorization: <token>' \
--header 'content-type: application/json' \
--data-raw '{
"task": "verification",
"essentials": {
"fileNumber": "<file number of the passport>",
"dob": "<date of birth>",
"name": "<name>",
"fuzzy": "true/false"
}
}'Response Parameter
Parameter Name | Description |
|---|---|
essentials | Essential part of the request |
essentials.fileNumber | File Number associated with the passport |
essentials.dob | Date of birth of passport holder. |
essentials.name | Name of passport holder. |
essentials.fuzzy | strings that match a pattern approximately. identifies similar, but not identical elements in data table sets. |
id | Unique User ID |
patronId | Unique Patron ID |
task | Task to be performed- verification |
result | Response obtained corresponding to API hit |
result.verified | Status of verification (i.e. true/false) |
result.message | Message corresponding to status of verification |
result.upstreamName | Name as recorded in the passport database. |
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].