Identity Object Creation
Note: Required for using V2 gateway APIs.
Signzy's identity APIs are interfaces that simplify and enhance identity document verification. By integrating Signzy's identity APIs, companies can streamline user onboarding, KYC compliance, and identity verification processes. This creates a secure and user-friendly experience for customers.
Signzy's APIs analyze the extracted information from identity documents, and cross-reference it with relevant databases to validate individuals' identities. This process enhances security and trust in applications.
Signzy's identity APIs offer well-documented interfaces and comprehensive support, making integration effortless. Developers can focus on their core functionalities while leveraging Signzy's expertise in digital trust solutions.
In summary, Signzy's identity APIs simplify and enhance identity document verification, improving security and trust in applications while providing a seamless user experience.
Creating an Identity object will require you to be logged in using the username and password(API-key). To know how to authenticate visit the Authentication section.
Before performing any auto recognition, verification or forgery check, you need to create an Identity object. All operations related to a particular ID card are executed through this object.
Endpoint:
POST https://signzy.tech/api/v2/patrons/<patron-id>/identitiesPOST https://preproduction.signzy.tech/api/v2/patrons/<patron-id>/identitiesPath parameters:
Parameters | Data type | Description | Required |
|---|---|---|---|
patron-id | String | Unique identifier of the Business. You can get it in the response to the Authentication API(userId argument). | Yes |
Request body parameters:
Parameters | Data type | Description | Required |
|---|---|---|---|
type | String | Defines the type of identity card. Allowed values: - individualPan - businessPan - aadhaar - passport - drivingLicence - cheque - voterid | Yes |
String | | Yes | |
callbackUrl | String | | Yes |
images | Array | | yes |
{
"type": "aadhaar",
"callbackUrl": "https://your-domain.com/your-callback-system",
"email": "[email protected]",
"images": [
"https://xyz.signzy.tech/api/files/38073187/download/xyz.jpg"
]
}Request headers:
Name | Value |
|---|---|
Content-Type | application/json |
Authorization | XXXXXXXXXXX - Value received as part of Authentication API(id argument). |
Code samples:
curl --location --globoff 'https://preproduction.signzy.tech/api/v2/patrons/{{patron_id}}/identities' \
--header 'Authorization: random_token' \
--header 'Content-Type: application/json' \
--data-raw '{
"type": "aadhaar",
"callbackUrl": "https://your-domain.com/your-callback-system",
"email": "[email protected]",
"images": [
"https://xyz.signzy.tech/api/files/38073163/download/xyz.jpg"
]
}'Response body parameters:
Parameter | Data Type | Description |
|---|---|---|
type | String | The type of identity verified (e.g., "aadhaar"). |
String | The email address associated with the identity. | |
callbackUrl | String | The URL for callback notifications and responses. |
images | Array of Strings | URLs of the processed images. |
accessToken | String | The access token for further API operations. |
autoRecognition | Array | Auto recognition results. |
verification | Array | Verification results. |
forgeryCheck | Array | Forgery check results. |
id | String | The unique identifier for the response. Needs to be used as the itemId in other identity requests. |
patronId | String | The unique identifier for the patron. |
{
"type": "aadhaar",
"email": "[email protected]",
"callbackUrl": "https://your-domain.com/your-callback-system",
"images": [
"https://xyz.signzy.tech/api/files/38073163/download/xyz.jpg"
],
"accessToken": "XXXXXXXXXXX",
"autoRecognition": [],
"verification": [],
"forgeryCheck": [],
"id": "..,item_id...",
"patronId": "...patron_id..."
}FAQ:
1) What is the accessToken key in the request & what is the itemId key in the request?
PFB steps to request an Identity API:
- First > Hit the login API (Authentication) where the Auth Token (AccessToken) & Patron ID gets generated. (POST :: https://signzy.tech/api/v2/patrons/login)
- Second > Identities flow for specific Doc Type has to be called; For Ex: Pan and Aadhaar Link Status > Pass the Auth key generated from First API call in the HEADERS & Patron ID in the Endpoint URL. In return you will get another set of ItemID and AccessToken that needs to be passed as an input for the third API call. (POST :: https://signzy.tech/api/v2/patrons//identities)
- Third > This is the final API call where Snoops request is called > You will be passing the ItemID & AccessToken (Generated from Identities Flow) in the request payload. Then, pass the essential input and complete the request to get the expected output. (POST :: https://signzy.tech/api/v2/snoops)
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!