KYC extraction APIs

PAN Extraction

Introduction
PAN Extraction API, is a robust solution designed to simplify the retrieval of information from PAN (Permanent Account Number) documents. This API efficiently processes images of PAN cards, extracting key details with precision. You simply need to provide the image URL of the PAN document, and our API does the rest, returning essential data such as the holder's name, date of birth, father's name, PAN number, type and other pertinent information. Ideal for verification processes, our API ensures accuracy and speed, streamlining data extraction tasks. With a straightforward cURL request, users can effortlessly integrate this service into their systems, enhancing their data management capabilities.
﻿
API details
Endpoint
Production environment
POST https://api.signzy.app/api/v3/pan/extractions
POST https://api.signzy.app/api/v3/pan/extractions
﻿
UAT/Testing environment
POST https://api-preproduction.signzy.app/api/v3/pan/extractions
POST https://api-preproduction.signzy.app/api/v3/pan/extractions
﻿
﻿
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
files
Array of Strings
An array containing the URL of the files being extracted.
Mandatory
type
String
The value here would be "individualPan". If you want to use the same endpoint for business PANs, pass the type as "businessPan".
Mandatory
getRelativeData
Boolean
Get an extra object for relative details in the response by using this parameter. The possible values are true or false.
optional
JSON
{
  "files": [
    "https://preproduction-persist.signzy.tech/api/files/37100725/download/XXXXXXXXX.jpg"
  ],
  "type":"individualPan",
  "getRelativeData": true
}
{
  "files": [
    "https://preproduction-persist.signzy.tech/api/files/37100725/download/XXXXXXXXX.jpg"
  ],
  "type":"individualPan",
  "getRelativeData": true
}
﻿
﻿
Code samples
Curl
Node.js
Python
Go
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api-preproduction.signzy.app/api/v3/pan/extractions"
  method := "POST"

  payload := strings.NewReader(`{
  "files": [
    "https://preproduction-persist.signzy.tech/api/files/37100725/download/XXXXXXXXX.jpg"
  ],
  "type":"individualPan",
  "getRelativeData": true
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "<Your access token>")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api-preproduction.signzy.app/api/v3/pan/extractions"
  method := "POST"

  payload := strings.NewReader(`{
  "files": [
    "https://preproduction-persist.signzy.tech/api/files/37100725/download/XXXXXXXXX.jpg"
  ],
  "type":"individualPan",
  "getRelativeData": true
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "<Your access token>")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
﻿
 Response body parameters
Parameter
Data Type
Description
files
Array of strings
An array containing the URL of the document.
type
String
PAN type specified in the request.
id
Integer
Unique ID for the request.
result
Object
Contains the result of the task.
result.dob
String
Date of birth of the individual in format DD/MM/YYYY.
result.name
String
Name of the PAN card holder.
result.fatherName
String
Father’s name of the PAN card holder.
result.number
String
The PAN card number.
result.panType
String
Pan type, The possible values are: "Minor" or "Adult"
result.summary
Object
Summary of extracted details.
result.summary.number
String
The PAN card number.
result.summary.name
String
The name on the PAN card.
result.summary.dob
String
Date of birth of the individual in format DD/MM/YYYY.
result.summary.address
String
Full address of the individual.
This detail is not available.
result.summary.splitAddress
Object
Contains the address in split format.
This detail is not available.
result.summary.splitAddress.district
Array of strings
District.
result.summary.splitAddress.state
Array of strings
State.
result.summary.splitAddress.city
Array of strings
City.
result.summary.splitAddress.pincode
String
Pincode.
result.summary.splitAddress.country
Array of strings
Country
result.summary.splitAddress.addressLine
String
Address line
result.summary.gender
String
The gender of PAN card holder.
This detail is not available.
result.summary.guardianName
String
The name of the guardian.
result.summary.issueDate
String
The issue date of the PAN card.
This detail is not for Individual PAN available.
result.summary.expiryDate
String
The expiry date of the PAN card.
This detail is not available.
result.summary.relativeDetails
Object
Relative details on the PAN card
result.summary.relativeDetails.name
String
Relative name on the PAN card
result.summary.relativeDetails.name
String
Relation name
200
200 (relativeDetails=true)
400
401
409
{
    "error": {
        "message": "One or more File(s) not valid",
        "name": "error",
        "status": 400,
        "reason": "Error",
        "type": "Bad Request",
        "statusCode": 400
    }
}

// Invalid PAN type
{
    "error": {
        "message": "Invalid Type",
        "name": "error",
        "status": 400,
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": 400
    }
}

// file size limit exceeded
{
    "error": {
        "message": "File size is greater than 5.000 MB",
        "name": "error",
        "status": 400,
        "reason": "Error",
        "type": "Bad Request",
        "statusCode": 400
    }
}
{
    "error": {
        "message": "One or more File(s) not valid",
        "name": "error",
        "status": 400,
        "reason": "Error",
        "type": "Bad Request",
        "statusCode": 400
    }
}

// Invalid PAN type
{
    "error": {
        "message": "Invalid Type",
        "name": "error",
        "status": 400,
        "reason": "VALIDATION_ERROR",
        "type": "Bad Request",
        "statusCode": 400
    }
}

// file size limit exceeded
{
    "error": {
        "message": "File size is greater than 5.000 MB",
        "name": "error",
        "status": 400,
        "reason": "Error",
        "type": "Bad Request",
        "statusCode": 400
    }
}
﻿
Document related constraints
The size of the document should not exceed 5 MB.
For best results, ensure the image you use fits tightly in the camera view and horizontally aligned.
Supported document types:
Image - JPEG, JPG, PNG and TIFF/TIF.
Single page PDF - In the case of multipage PDF input the API will only consider the first page for extraction.
﻿
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!

Aadhaar Extraction

[Beta] NREGA CARD

Docs powered by Archbee

TABLE OF CONTENTS

Request body parameters

Code samples

Response body parameters

Document related constraints

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
files	Array of Strings	An array containing the URL of the files being extracted.	Mandatory
type	String	The value here would be "individualPan". If you want to use the same endpoint for business PANs, pass the type as "businessPan".	Mandatory
getRelativeData	Boolean	Get an extra object for relative details in the response by using this parameter. The possible values are true or false.	optional