Verification-1 API
Introduction
The PAN details must be manually validated by the user before sending them to the SIGNZY verification service. Upon receiving the details, they are cross-checked against government records to verify the authenticity of the details provided by the user. This is the basic verification service where only the name and PAN number will be verified.
How to call the API
Before going for Verification calls, you first need to create an Identity object. The user details must be unique and the PAN Number with the name is mandatory.
API Input Guidelines
- PAN card number in upper/lower case
Step 1: Hit Identities API
Sample cURL Request
curl --location --request POST 'https://preproduction.signzy.tech/api/v2/patrons/..patronId../identities' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "bussinessPan",
"email": "<email Id>",
"callbackUrl": "https://www.w3schools.com",
"images": [<images Url>]
}'Input Parameters
Parameters Name | Description | Required/Optional |
|---|---|---|
Authorization | Contains the id parameter returned from the login step | Required |
Content-Type | application/json | Required |
type | Type of Identity | Required |
callbackurl | URL where response will be posted | Required |
images | Front and Back side Image of Passport | Required |
Step 2: Hit Snoops API and receive a response
Sample CURL
curl --location --request POST 'https://preproduction.signzy.tech/api/v2/snoops' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
"service":"Identity",
"itemId":"<Identity-object-id>",
"task":"verification",
"accessToken":"<Identity-access-token>",
"essentials":{
"number":"<PAN-as-mentioned-on-the-card>",
"name":"<Name-corresponding-to-the-given-pan>",
"fuzzy":"true/false"
}
}'Input Parameters
PARAMETER NAME | DESCRIPTION |
|---|---|
Content-Type | Contains the id parameter returned from the login step |
service | Type of Signzy service - “identity extraction” |
itemId | Contains the identity item id |
accessToken | Identity access token |
task | The type of task performed - “Auto Verification” |
essentials | Contains the essential output data |
essentials.name | Name written on PAN card |
essentials.number | PAN Number |
essentials.fuzzy | Fuzzy match the name |
Sample API Response
{
"service": "Identity",
"itemId": " ",
"task": "verification",
"essentials": {
"number": " ",
"name": " ",
"fuzzy": "true",
"state": "Maharastra",
"instance": {}
},
"accessToken": " ",
"id": " ",
"response": {
"name": " ",
"number": " ",
"fuzzy": "true",
"id": 22729,
"state": "Maharastra",
"instance": {
"id": " ",
"callbackUrl": " "
},
"result": {
"verified": true,
"message": "Verification completed with positive result",
"upstreamName": " "
}
}
}Response Parameters
PARAMETER NAME | DESCRIPTION |
|---|---|
service | Type of Signzy service - “identity extraction” |
itemId | Identity item id |
task | The type of task performed - “Verification” |
essentials | Essential output data |
essentials.name | Name written on PAN card |
essentials.number | PAN Number |
essentials.fuzzy | It performs the name match if it is true and does not if false should be written |
accessToken | Access token received from identity request |
id | Unique user Id |
response | Contain output result |
response.name | Name of the bussiness |
response.number | PAN number of the bussiness |
response.fuzzy | Fuzzy match name or not |
response.id | ID of the response |
response.state | State in which the bussiness is Registered |
instance.id | ID of the instance |
instance.callbackUrl | URl where the response will be posted |
result | The output of the response |
result.verified | Contains the verification status "true/false" |
result.message | This parameter displays the verification success/failure message to the user. |
result.upstreamName | This parameter checks the details of the PAN against the existing records in the 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].