Fetch API
Introduction
This API is used to fetch the details of Indian passport holders
How to call the API
Before going for Verification 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 put 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": "<call back Url>",
"images": [
"<Front Image Url> ",
"<Back Image 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 | Front and back image of passport |
Sample Response
{
"type": "passport",
"email": "[email protected]",
"callbackUrl": "",
"images": [
"image1.jpg",
"image2.jpg"
],
"accessToken": "",
"autoRecognition": [],
"verification": [],
"forgeryCheck": [],
"id": "",
"patronId": ""
}Response Parameter
Parameter Name | Description | ||
|---|---|---|---|
type | Type of identity Type of identity Type of identity | ||
e-mail ID | |||
callbackurl | URL where response will be posted | ||
images | Front and back image of passport | ||
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 receives 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": "fetch",
"essentials": {
"fileNumber": "",
"dob": ""
}
}'Input Parameters
Parameter Name | Required/Optional | Description | |
|---|---|---|---|
content-type | Required | application/json | |
service | Required | Type of Signzy service - “identity extraction” | |
itemId | Required | Contains the identity item id | |
accessToken | Required | This is provided by the identities API | |
task | Required | The type of task performed - “Auto Recognition” The type of task performed - “Auto Recognition” | |
essentials | Required | Contains the essential output data | |
essentials.fileNumber | Required | Contains file number of the passport | |
essentials.dob | Required | contains the date of birth |
Sample API Response
{
"service": "Identity",
"itemId": "",
"task": "fetch",
"essentials": {
"fileNumber": "",
"dob": "",
"instance": {
"id": "",
"callbackUrl": ""
}
},
"accessToken": "",
"id": "",
"response": {
"fileNumber": "",
"dob": "",
"id": 227,
"instance": {
"id": "",
"callbackUrl": ""
},
"result": {
"fileNumber": "",
"givenName": "",
"surname": "",
"typeOfApplication": "",
"applicationReceivedOnDate": "",
"name": "",
"dob": ""
}
}
}
Output Parameters
Parameter Name | Description | |
|---|---|---|
service | Type of Signzy service - “identity extraction” | |
itemId | Contains the identity item id | |
task | The type of task performed - “Auto Recognition” | |
essentials.fileNumber | Contains file number of the passport | |
essentials.dob | Contains date of the birth of the passport holder | |
essentials.instance.id | Contains identity id | |
essentials.instance.callbackUrl | URL where response will be posted | |
response.result.fileNumber | Contains file number of the passport holder | |
response.result.givenName | Contain the name of the passport holder | |
response.result.surname | Contain the surname of the passport holder Contain the name of the passport holder | |
response.result.typeOfApplication | Shows the application type | |
response.result.applicationReceivedOnDate | Contains the date on which passport is applied | |
response.result.name | Contains the name of the applicant | |
response.result.dob | Contains date of birth of the applicant |
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].