Verification API
Introduction
This API is used to verify the passport details of any Indian Passport.
How to call the API
Before going for Auto reading calls, you first need to create an Identity object. Need to pass accessToken and itemid obtained from identity call along with other input parameters
API Input Guidelines
- Need to give Name, File Number and Date of Birth as Input
Step 1: Hit Identities API
Sample cURL
curl --location --request POST 'https://preproduction.signzy.tech/api/v2/patrons/..patronId../identities' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "passport",
"email": "<email ID>",
"callbackUrl": "https://www.w3schools.com",
"images": [<Images Url>]
}'Input Parameters
Parameter Name | Required/Optional | Description |
|---|---|---|
Authorization | Required | Contains the id parameter returned from the login step |
Content-Type | Required | application/json |
type | Required | Type of identity |
Required | e-mail ID | |
callbackurl | Required | URL where response will be posted |
images | Required | Images URL |
Sample Response
{
"type": "passport",
"email": "[email protected]",
"callbackUrl": "",
"images": [],
"accessToken": "",
"autoRecognition": [],
"verification": [],
"forgeryCheck": [],
"id": "",
"patronId": ""
}Response Parameter
Parameter Name | Description |
|---|---|
type | Type of identity |
e-mail ID | |
callbackUrl | URL where response will be posted |
images | Url of front image |
accessToken | This is provided by identities API |
autoRecognition | Auto recognises text from upload image |
verification | verification is done |
forgeryCheck | Forgery check is done |
id | Unique user id |
patronId | Unique patron id |
Step 2: Hit Snoops API and receive a response
Sample cURL
curl --location --request POST 'https://preproduction.signzy.tech/api/v2/snoops' \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.8' \
--header 'content-type: application/json' \
--data-raw '{
"service": "Identity",
"itemId": " ",
"accessToken": " ",
"task": "verification",
"essentials": {
"fileNumber": " ",
"dob": " ",
"name": " ",
"fuzzy": "<fuzzy>"
}
}'Input Parameters
Parameter Name | Required/Optional | Description |
|---|---|---|
content-type | Required | application/json |
service | Required | Type of Signzy service - “identity verification” |
itemId | Required | Contains the identity item id |
accessToken | Required | This is provided by the identities API |
task | Required | Task being performed |
essentials | Required | Contains the essential output data |
Sample API Response
{
"service": "Identity",
"itemId": "",
"task": "verification",
"essentials": {
"fileNumber": "",
"dob": "",
"name": "",
"fuzzy": "<fuzzy>",
"instance": {
"id": "",
"callbackUrl": ""
}
},
"accessToken": "",
"id": "a",
"response": {
"fileNumber": "",
"dob": "",
"name": "",
"fuzzy": "true",
"id": 5581,
"instance": {
"id": "",
"callbackUrl": ""
},
"result": {
"verified": "true",
"message": "",
"upstreamName": ""
}
}
}
Output Parameters
Parameter Name | Description |
|---|---|
service | Type of Signzy service - “identity verification” |
itemId | Contains the identity item id |
task | The type of task performed - “Auto Recognition” |
essentials.fileNumber | Contains the file number of the passport |
essentials.dob | Contains Date of Birth of the passport holder |
essentials.name | Contains name of the passport holder |
essentials.fuzzy | Fuzzy match the name |
essentials.instance.id | Contains the unique Id |
essentials.instance.callbackUrl | URL where response will be posted |
accessToken | Contains the unique access Token |
id | Contains Unique Id |
response.fileNumber | Contains file number of the passport |
response.dob | Contains Date of Birth |
response.name | Contains Name of the passport holder |
response.fuzzy | Verifies true or false |
response.id | ID of the response |
response.instance.id | Contains Unique Id |
response.callbackUrl | URL where response will be posted |
response.result.verified | Verifies True or False |
response.result.message | Shows message of the result |
response.result.upstreamName | Contains name of the passport holder |
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].