Static ID extraction
Introduction
Static ID Extraction helps in extraction of information present on ID card (password protected zip or xml) and can be verified from user inputs or other sources.
API Endpoint's
POST https://api.signzy.app/api/v3/identity/offlineExtractionPOST https://api-preproduction.signzy.app/api/v3/identity/offlineExtractionRequest body parameters
Parameter | Data Type | Description | Mandatory |
|---|---|---|---|
url | String | The URL value of the ID card ZIP or XML file. | Mandatory |
password | String | The password needs to be passed for ZIP files. | Conditionally Mandatory |
{
"url": "xxxxxx",
"password": "yyyyy"
}Request headers
Name | Value | Required | Description |
|---|---|---|---|
Content-Type | application/json | Mandatory | The type of content that the request body contains. |
Authorization | XXXXXXXXXXXXXXX | Mandatory | An authentication token to authorize the request. Reach out to the Signzy support team to get one created. |
Code Samples
curl --location 'https://api-preproduction.signzy.app/api/v3/identity/offlineExtraction' \
--header 'Content-Type: application/json' \
--header 'Authorization: <your access token>' \
--data '{
"url":"xxxxxx",
"password":"yyyyyyy"
}'Response body parameters
Parameter | Data Type | Description |
|---|---|---|
result | Object | The main container for the response information. |
result.name | String | The name of the individual. |
result.dob | String | Date of birth in the format "xx/xx/xxxx". |
result.yob | String | Year of birth (four digits). |
result.gender | String | Gender information. |
result.emailHash | String | Hashed email information. |
result.mobileNoHash | String | Hashed mobile number information. |
result.address | String | Complete address information. |
result.photo | String | URL to the individual's photo. |
result.idLast4Digits | String | The last four digits of the ID. |
result.poi | String | The ID with the "XXXXXXXX" prefix. |
result.generationDate | String | Date of information generation in the format "xx/xx/xxxx". |
result.generationTime | String | Time of information generation in the format "xx:xx:xx". |
result.unixTimeStamp | Number | Unix timestamp representing the generation time. |
result.dateDifference | Number | Difference in dates (assuming related to generation date). |
result.expiryTime | String | Expiry time information. |
result.emailHashVerified | String | Email hash verification status. |
result.mobileHashVerified | String | Mobile hash verification status. |
result.splitAddress | Object | Subdivided address details. |
result.splitAddress.district | Array | Array containing district information. |
result.splitAddress.state | Array | Array containing state information, with possible abbreviations. |
result.splitAddress.city | Array | Array containing city information. |
result.splitAddress.pincode | String | The postal code of the address. |
result.splitAddress.country | Array | Array containing country information, with possible abbreviations. |
result.splitAddress.addressLine | String | The street address line. |
result.x509Data | Object | X.509 certificate details. |
result.x509Data.subjectName | String | X.509 subject name information. |
result.x509Data.certificate | String | X.509 certificate information. |
result.x509Data.details | Object | Additional details related to X.509 certificate. |
result.x509Data.validIDDSC | String | Valid ID Digital Signature Certificate (DSC) status. |
{
"error": {
"statusCode": 409,
"name": "error",
"message": "Upstream Down",
"status": 409
}
}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!