Offline KYC ID extraction API

Introduction

As an KYC ID is a bio-metric document that stores an individual’s details in a government database and is fast becoming the government’s base for public welfare and citizen services. And in Offline KYC ID Extraction information present on KYC ID (password protected zip or xml) will be extracted and can be verified from user inputs or other sources.

API Endpoint's

POST https://api.signzy.app/api/v3/identity/offlineExtraction

POST https://api-preproduction.signzy.app/api/v3/identity/offlineExtraction

Request body parameters

Parameter	Data Type	Description	Mandatory
url	String	The URL value of the KYC ID ZIP or XML file.	Mandatory
password	String	The password needs to be passed for ZIP files.	Conditionally Mandatory
consent	String	Consent of user Y, N It has to be Y to process the request	Mandatory

{
    "url": "https://persist.signzy.tech/api/files/1326240800/download/XXXX.zip",
    "password": "",
    "consent": "Y"
}

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: <auth_k' \
--data '{
    "url": "https://persist.signzy.tech/api/files/1326240800/download/XXXX.zip",
    "password": "",
    "consent": "Y"
}'

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.kycIdLast4Digits	String	The last four digits of the kycId.
result.kycId	String	The kycId 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.validKycIdDSC	String	Valid KycId Digital Signature Certificate (DSC) status.

{
  "result": {
    "name": "****",
    "dob": "****",
    "yob": "****",
    "gender": "****",
    "emailHash": "****",
    "mobileNoHash": "****",
    "address": "****",
    "photo": "****",
    "kycIdLast4Digits": "****",
    "kycId": "****",
    "generationDate": "****",
    "generationTime": "****",
    "unixTimeStamp": "****",
    "dateDifference": "****",
    "expiryTime": "****",
    "emailHashVerified": "****",
    "mobileHashVerified": "****",
    "splitAddress": {
      "district": ["****"],
      "state": [["****", "****"]],
      "city": ["****"],
      "pincode": "****",
      "country": ["****", "****", "****"],
      "addressLine": "****"
    },
    "x509Data": {
      "x509Data": {
        "subjectName": "****",
        "certificate": "****",
        "details": {
          "version": "****",
          "subject": {
            "countryName": "****",
            "organizationName": "****",
            "postalCode": "****",
            "stateOrProvinceName": "****",
            "streetAddress": "****",
            "houseIdentifier": "****",
            "commonName": "****"
          },
          "issuer": {
            "countryName": "****",
            "organizationName": "****",
            "organizationalUnitName": "****",
            "postalCode": "****",
            "stateOrProvinceName": "****",
            "streetAddress": "****",
            "houseIdentifier": "****",
            "commonName": "****"
          },
          "serial": "****",
          "notBefore": "****",
          "notAfter": "****",
          "subjectHash": "****",
          "signatureAlgorithm": "****",
          "fingerPrint": "****",
          "publicKey": {
            "algorithm": "****"
          },
          "altNames": ["****"],
          "extensions": {
            "basicConstraints": "****",
            "extendedKeyUsage": "****",
            "privateKeyUsagePeriod": "****",
            "entrustVersionInfo": "****",
            "authorityKeyIdentifier": "****",
            "subjectKeyIdentifier": "****",
            "keyUsage": "****",
            "subjectAlternativeName": "****",
            "certificatePolicies": "****",
            "cRLDistributionPoints": "****"
          }
        },
        "validKycIdDSC": "****"
      }
    }
  },
   "message": "Success",
    "reason": "REQUEST_SUCCESSFUL",
    "code": "S001"
}

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!

{
    "service": "Identity",
    "itemId": "...id....",
    "task": "autoRecognition",
    "essentials": {},
    "accessToken": "...access token from identity request...",
    "id": "...id...",
    "response": {
        "result": {
            "name": "...name of person...",
            "dob": "..date of birth...",
            "yob": "..year of birth...",
            "gender": "...gender...",
            "emailHash": "...hash of email...",
            "mobileNoHash": "...hash of mobile number...",
            "x509Data": {
                "subjectName": "",
                "certificate": "",
                "details": {},
                "validKycIdDSC": "...dsc status..."
            },
            "address": "...address ....",
            "photo": "...url to the image...",
            "emailHashVerified": "yes/no/NA",
            "mobileHashVerified": "yes/no/NA",
            "uidLast4Digits": "5190",
            "uid": "XXXXXXXX5190",
            "generationDate": "13/08/2020",
            "generationTime": "23:36:44",
            "unixTimeStamp": 1597342004,
            "dateDifference": 0,
            "splitAddress": {
                "district": [
                    "...district.."
                ],
                "state": [
                    [
                        "..state name...",
                        "...state code..."
                    ]
                ],
                "city": [
                    "...city name..."
                ],
                "pincode": "...pincode...",
                "country": [
                    "IN",
                    "IND",
                    "INDIA"
                ],
                "addressLine": "...address line..."
            }
        }
    }
}