Cancelled Cheque Extraction

4 min

Introduction

The API enables users to send a request to the Signzy server, providing relevant details such as the service required, identity item ID, access token, and the type of task to be performed. The server then responds with the output of the requested task, which in this case is an automatic recognition of the identity provided.One of the endpoints provided by the API is the "/snoops" endpoint. This endpoint allows users to perform auto-recognition of an identity document using Signzy's Identity service.

Sample CURL

curl --request POST \
  --url https://signzy.tech/api/v2/snoops \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'content-type: application/json' \
  --data '{"service":"Identity","itemId":"<Identity-ID>","accessToken":"<Identity-token>","task":"autoRecognition","essentials":{}}'

Parameter	Type	Description
service	String	The name of the Signzy service to be used. In this case, it should be set to "Identity".
itemId	String	The unique identifier of the identity document to be recognized. This should be replaced with the actual Identity ID.
accessToken	String	The access token for the Signzy service. This should be replaced with the actual Identity token.
task	String	The name of the task to be performed by the API. In this case, it should be set to "autoRecognition".
essentials	JSON Object	An optional JSON object that can contain additional parameters required for the task. In this case, it is not used and can be left as an empty object.

Sample API Response

{

  	"result": {
  		"address": "...address...",
  		"ifsc": "...ifsc...",
  		"pincode": "...pincode...",
  		"accountNumber": "...accountNumber...",
  		"bankName": "...bankName...",
  		"micrCode": "....micrCode...",
  		"contact": "...contact..",
  		"branch": "...branch...",
  		"name": "...name...",
  		"splitAddress": {
  			"state": [
  				[]
  			],
  			"district": [],
  			"city": [],
  			"pincode": "...pincode...",
  			"country": [
  				"IN",
  				"IND",
  				"INDIA"
  			],
  			"addressLine": "...addressLine..."
  		},
        "summary": {
            "number": "..accountNumber...",
            "name": "..name..",
            "dob": "",
            "address": "...address as on card...",
            "splitAddress": {
              "state": [
                []
              ],
              "district": [],
              "city": [],
              "pincode": "...pincode...",
              "country": [
                "IN",
                "IND",
                "INDIA"
              ],
              "addressLine": "...addressLine..."
            },
            "gender": "",
            "guardianName": "",
            "issueDate": "",
            "expiryDate": ""
        }

  	}
  }

Parameter	Description
result.address	The address associated with the bank account.
result.ifsc	The Indian Financial System Code (IFSC) of the bank associated with the account.
result.pincode	The postal code associated with the bank account.
result.accountNumber	The account number of the bank account.
result.bankName	The name of the bank associated with the account.
result.micrCode	The Magnetic Ink Character Recognition (MICR) code associated with the bank account.
result.contact	The contact number associated with the bank account.
result.branch	The branch name associated with the bank account.
result.name	The name of the account holder.
result.splitAddress.state	The state of the account holder's address, split into separate components if applicable.
result.splitAddress.district	The district of the account holder's address.
result.splitAddress.city	The city of the account holder's address.
result.splitAddress.pincode	The postal code of the account holder's address.
result.splitAddress.country	The country of the account holder's address, represented in different formats.
result.splitAddress.addressLine	The address line of the account holder's address.
result.summary.number	The account number of the bank account.
result.summary.name	The name of the account holder.
result.summary.dob	The date of birth of the account holder.
result.summary.address	The address of the account holder, as it appears on the card.
result.summary.splitAddress.state	The state of the account holder's address, split into separate components if applicable.
result.summary.splitAddress.district	The district of the account holder's address.
result.summary.splitAddress.city	The city of the account holder's address.
result.summary.splitAddress.pincode	The postal code of the account holder's address.
result.summary.splitAddress.country	The country of the account holder's address, represented in different formats.
result.summary.splitAddress.addressLine	The address line of the account holder's address.
result.summary.gender	The gender of the account holder.
result.summary.guardianName	The name of the account holder's guardian.
result.summary.issueDate	The issue date of the account holder's card.
result.summary.expiryDate	The expiry date of the account holder's card.