Verification API
Introduction
This Api is used to verify Voter Identity of any indian citizen by giving the Epic number, Name and state as input.
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 Put Epic Number, Name and State as input.
- Input must be given in the format as on the Identity.
Step 1: Hit Identities API
Sample cURL
curl --location --request POST 'https://preproduction.signzy.tech/api/v2/patrons/..patronId../identities?access_token=PagFCJr2GrFEEzJMWFqPS8nuWR6lxdqFMOGrcrdsHdf4lZq55wwA7eYfFOmRhbtk' \
--header 'Content-Type: application/json' \
--header 'Authorization: <token>' \
--data-raw '{
"type": "voterid",
"email": "<email Id>",
"callbackUrl": "<Call back Url>",
"images": [<Url link of images>
]
}'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 | URL link of images |
Sample Response
{
"type": "voterid",
"email": "",
"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 link of images |
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 'Content-Type: application/json' \
--data-raw '{
"service": "Identity",
"itemId": "",
"task": "verification",
"accessToken": "",
"essentials": {
"epicNumber":"",
"name":"",
"state":""
}
}'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 |
task | Required | Task will be - verification |
accessToken | Required | This is provided by the identities API |
essentials | Required | conatins the required input data |
essentials.epicNumber | Required | Contains epic Number |
essentials.name | Required | Contains name of the card holder |
essentials.state | Required | Contains state name |
Sample API Response
{
"service": "Identity",
"itemId": "",
"task": "verification",
"essentials": {
"epicNumber": "",
"name": "",
"state": "",
"instance": {
"id": "",
"callbackUrl": ""
}
},
"accessToken": "",
"id": "",
"response": {
"epicNumber": "",
"name": "",
"state": "",
"instance": {
"id": "",
"callbackUrl": ""
},
"id": 531,
"result": {
"verification": true,
"message": "Verification completed with positive result"
}
}
}
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.epicNumber | Contains Epic Number |
essentials.name | Contains name of the card holder |
essentials.state | Contains state name |
essentials.instance.id | Contains unique Id |
accessToken | Contains access Token |
id | Contains unique ID |
essentials.instance.callbackUrl | URL where response will be posted |
response.epicNumber | Contains Epic number of the Identity Proof |
response.name | Contains Name of the Voter Id holder |
response.state | Contains state name where the address is located |
response.instance.id | Contains unique id |
response.instance.callbackUrl | URL where response will be posted |
response.id | Contains unique ID |
response.result.verification | It is either true or false |
response.result.message | Contains the result message |
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].