PAN extraction V2
Introduction
Signzy's PAN extraction API allows developers to integrate an automated PAN card extraction service into their applications. By leveraging machine learning algorithms, this API can recognize and extract relevant information from images or PDF documents of PAN cards, such as the cardholder's name, father's name, date of birth, and PAN number. The API provides a simple and convenient way to automate PAN extraction and processing, saving time and effort for businesses and individuals. In this documentation, you will find all the information you need to use the API, including request and response formats, error handling, and usage examples.
API details
Endpoint
POST https://signzy.tech/api/v2/snoopsPOST https://preproduction.signzy.tech/api/v2/snoopsRequest headers
Name | Value | Required | Description |
|---|---|---|---|
Content-Type | application/json | Mandatory | The type of content that the request body contains. |
Request body parameters
Parameter | Data Type | Description | Required |
|---|---|---|---|
service | String | The name of the service being requested. It should be ”Identity” in this case. | Mandatory |
itemId | String | Unique ID for the document being extracted/Verified. This is returned as “id” in the identity object API. | Mandatory |
task | String | The specific task or action to perform. It should be “autoRecognition". | Mandatory |
accessToken | String | An authentication token to authorize the request. This is returned as “accessToken” in the identity object API. | Mandatory |
essentials | Object | Contains the essential parameters for the task. In this case, it is empty. | Mandatory |
{
"service":"Identity",
"itemId":"XXXXXXXXXX",
"task":"autoRecognition",
"accessToken":"XXXXXXXXXXX",
"essentials":{}
}Code samples
curl --location 'https://preproduction.signzy.tech/api/v2/snoops' \
--header 'Authorization: <your-access-token>' \
--header 'Content-Type: application/json' \
--data '{
"service":"Identity",
"itemId":"XXXXXXXXXXX",
"task":"autoRecognition",
"accessToken":"XXXXXXXXXX",
"essentials":{}
}'Response body parameters
Parameter | Data Type | Description |
|---|---|---|
service | String | The name of the service being requested in input. |
itemId | String | Unique ID for the document being extracted/Verified in the input is returned here. |
task | String | task in the input is returned here. |
accessToken | String | accessToken in the input is returned here. |
id | String | Unique ID for the task performed. |
response.files | Array of strings | An array containing the URL of the document. |
response.type | String | The type of PAN card. |
response.instance | Object | Contains the instance detail. |
response.instance.id | String | An ID associated with the instance. |
response.instance.callbackUrl | String | The callback URL for the request. |
response.id | Integer | Unique ID for the request. |
response.result.dob | String | Date of birth of the individual in format DD/MM/YYYY. |
response.result.name | String | The name of the PAN card holder. |
response.result.fatherName | String | Father’s name of the PAN card holder. |
response.result.number | String | The PAN card number. |
response.result.panType | String | The type of PAN card. |
response.result.summary.number | String | The PAN card number. |
response.result.summary.name | String | The name of the PAN card holder. |
response.result.summary.dob | String | Date of birth of the individual in format DD/MM/YYYY. |
response.result.summary.address | String | Full address of the individual. This detail is not available. |
response.result.summary.splitAddress | Object | Contains the split address. This detail is not available. |
response.result.summary.splitAddress.district | Array of strings | District. |
response.result.summary.splitAddress.state | Array of strings | State. |
response.result.summary.splitAddress.city | Array of strings | City. |
response.result.summary.splitAddress.pincode | String | The PIN code. |
response.result.summary.splitAddress.country | Array of strings | Country. |
response.result.summary.splitAddress.addressLine | String | The address line. |
response.result.summary.gender | String | The gender of PAN card holder. This detail is not available. |
response.result.summary.guardianName | String | The name of the guardian. |
response.result.summary.issueDate | String | The issue date of the PAN card. This detail is not available. |
response.result.summary.expiryDate | String | The expiry date of the PAN card. This detail is not available. |
{
"service": "Identity",
"itemId": "<Your ID generated for the document in Identity object API>",
"task": "autoRecognition",
"essentials": {},
"accessToken": "<Your access token generated in Identity Object API>",
"id": "",
"response": {
"files": [
"https://preproduction-persist.signzy.tech/api/files/38958617/download/000000000.pdf"
],
"type": "individualPan",
"instance": {
"id": "64feaceed1351a0023d27991",
"callbackUrl": "https://your-domain.com/your-callback-system"
},
"id": 34,
"result": {
"dob": "DD/MM/YYYY",
"name": "Name of the PAN holder",
"fatherName": "Father name",
"number": "XXXXX0000X",
"panType": "Adult",
"summary": {
"number": "XXXXX0000X",
"name": "Name of the PAN holder",
"dob": "DD/MM/YYYY",
"address": "",
"splitAddress": {
"district": [],
"state": [
[]
],
"city": [],
"pincode": "",
"country": [],
"addressLine": ""
},
"gender": "",
"guardianName": "Guardian Name",
"issueDate": "",
"expiryDate": ""
}
}
}
}Contact Us for Any Assistance
If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!