KYC extraction APIs

Single KYC Extraction

Introduction

This API allow users to extract information from different ID cards available in the country (currently supports only 'India'). In addition to extracting information from the image, the API employs Al analysis to determine the type of ID and return the same in idType.
﻿
API details
Endpoint
Production Environment
https://api.signzy.app/api/v3/single-kyc/extraction
https://api.signzy.app/api/v3/single-kyc/extraction
﻿
Production Environment
https://api-preproduction.signzy.app/api/v3/single-kyc/extraction
https://api-preproduction.signzy.app/api/v3/single-kyc/extraction
﻿
﻿
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.
﻿
Request body parameters
Parameter
Data type
Description
Required
urls
Array
A list of URL of the ID images. 
Acceptable image format TIFF/TIF, JPEG/JPG, PNG, PDF(maximum 2 pages).
Mandatory
country
String
Country of Origin of the ID.
Mandatory
idType
String
Type of the id card.
Optional
JSON
{
    "urls": [
        "https://preproduction-persist.signzy.tech/api/files/25535717/download/163.jpg"
    ],
    "country": "India",
    "idType" : ""
}
{
    "urls": [
        "https://preproduction-persist.signzy.tech/api/files/25535717/download/163.jpg"
    ],
    "country": "India",
    "idType" : ""
}
﻿
﻿
Code samples
Curl
Node.js
Python
Go
curl --location 'https://api-preproduction.signzy.app/api/v3/single-kyc/extraction' \
--header 'Content-Type: application/json' \
--header 'Authorization: < Auth Key >' \
--data '{
    "urls": [
        "https://preproduction-persist.signzy.tech/api/files/25535717/download/163.jpg"
    ],
    "country": "India",
    "idType" : ""
}'
curl --location 'https://api-preproduction.signzy.app/api/v3/single-kyc/extraction' \
--header 'Content-Type: application/json' \
--header 'Authorization: < Auth Key >' \
--data '{
    "urls": [
        "https://preproduction-persist.signzy.tech/api/files/25535717/download/163.jpg"
    ],
    "country": "India",
    "idType" : ""
}'
﻿
﻿
Response body parameters
Parameter
Data Type
Description
requestId
String
Unique identifier of the API request.
idType
String
Type of ID card as fetched after Al analysis, e.g. :  business PAN, aadhaar.
extractedFields
Object
Object containing all the extracted fields from the ID
extractedFields.name
String
Name of the person in the ID
extractedFields.dob
String
Date of birth of the person in the ID
extractedFields.idNumber
String
Unique Identification number of the ID
extractedFields.guardianName
String
Guardian name of the person in the ID
extractedFields.gender
String
Gender of the person in the ID
extractedFields.additionalData
Object
Object containing additional data related to the ID
200
401
422
413
409
400
{
    "requestId": "8241ef77-0596-42f5-b78a-b4db98f20cc6",
    "idType": "businessPan",
    "extractedFields": {
        "name": "XXXXX XXXXX",
        "dob": "DD/MM/YYYY",
        "idNumber": "xxxxxxxxx",
        "guardianName": "XXXXX XXXXX",
        "gender": "XXXX",
        "additionalData": {
            "dateOfIssue": "DD/MM/YYYY"
        }
    }
}
{
    "requestId": "8241ef77-0596-42f5-b78a-b4db98f20cc6",
    "idType": "businessPan",
    "extractedFields": {
        "name": "XXXXX XXXXX",
        "dob": "DD/MM/YYYY",
        "idNumber": "xxxxxxxxx",
        "guardianName": "XXXXX XXXXX",
        "gender": "XXXX",
        "additionalData": {
            "dateOfIssue": "DD/MM/YYYY"
        }
    }
}
﻿
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!

KYC and Utility extraction API

Aadhaar Extraction

Docs powered by Archbee

TABLE OF CONTENTS

Request body parameters

Code samples

Response body parameters

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.

Parameter	Data type	Description	Required
urls	Array	A list of URL of the ID images. Acceptable image format TIFF/TIF, JPEG/JPG, PNG, PDF(maximum 2 pages).	Mandatory
country	String	Country of Origin of the ID.	Mandatory
idType	String	Type of the id card.	Optional

Parameter	Data Type	Description
requestId	String	Unique identifier of the API request.
idType	String	Type of ID card as fetched after Al analysis, e.g. : business PAN, aadhaar.
extractedFields	Object	Object containing all the extracted fields from the ID
extractedFields.name	String	Name of the person in the ID
extractedFields.dob	String	Date of birth of the person in the ID
extractedFields.idNumber	String	Unique Identification number of the ID
extractedFields.guardianName	String	Guardian name of the person in the ID
extractedFields.gender	String	Gender of the person in the ID
extractedFields.additionalData	Object	Object containing additional data related to the ID