CKYC APIs

CKYC Distributor Fetch

Introduction
The Distributor CKYC Fetch API extends the functionalities of the standard CKYC Fetch API, catering to a broader range of business needs. This API enables the efficient extraction of detailed customer information based on their unique CKYC number, utilizing an `insurerId for access. Once the insurerId is provided, Signzy's system seamlessly handles the mapping to the relevant Financial Institution credentials. This process offers access to extensive data points, including Date of Birth, PAN number, address, parent's details, contact information, KYC declaration details, identity particulars, and associated images. It ensures compliance with regulatory requirements while enhancing identity verification and customer personalization, all through a single, streamlined API call.
﻿
API details
Endpoint
Production environment
POST https://api.signzy.app/api/v3/ckyc/distributor/fetch
POST https://api.signzy.app/api/v3/ckyc/distributor/fetch
﻿
UAT/Testing environment
POST https://api-preproduction.signzy.app/api/v3/ckyc/distributor/fetch
POST https://api-preproduction.signzy.app/api/v3/ckyc/distributor/fetch
﻿
﻿
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
insurerId
String
Unique identifier for the insurer. Please reach out to us at [email protected] to get the insurerId generated.
Mandatory
ckycNumber
String
14-digit Central KYC number associated with the individual.
Mandatory
authFactorType
String
The type of authentication to be used. 
For possible inputs, Refer to the table Authorization Factor Types below.
Mandatory
authFactorValue
String
The value associated with the authentication factor type used. 
For possible inputs, Refer to the table Authorization Factor Types below.
Mandatory
JSON
{
    "insurerId": "100025",
    "ckycNumber": "00000000000000",
    "authFactorType": "03",
    "authFactorValue": "DD-MM-YYYY"
}
{
    "insurerId": "100025",
    "ckycNumber": "00000000000000",
    "authFactorType": "03",
    "authFactorValue": "DD-MM-YYYY"
}
﻿
Authorization Factor Types
authFactorType
authFactorValue
authFactorValue-Format
01
Date of Birth of the Individual.
DD-MM-YYYY
02
Pincode of the registered address and Year of Birth.
XXXXXXYYYY 
Where XXXXXX is the Pincode and YYYY is the Birth Year.
03
10-digit Mobile number corresponding to the CKYC number.
0000000000
﻿
Code samples
Curl
Node.js
Python
Go
package main

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

func main() {

  url := "https://api.signzy.app/api/v3/ckyc/distributor/fetch"
  method := "POST"

  payload := strings.NewReader(`{
    "insurerId": "100025",
    "ckycNumber": "00000000000000",
    "authFactorType": "03",
    "authFactorValue": "DD-MM-YYYY"
}`)

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

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

  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.signzy.app/api/v3/ckyc/distributor/fetch"
  method := "POST"

  payload := strings.NewReader(`{
    "insurerId": "100025",
    "ckycNumber": "00000000000000",
    "authFactorType": "03",
    "authFactorValue": "DD-MM-YYYY"
}`)

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

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

  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
result
Object
An object containing the result of the task.
result.result
Object
A nested object containing the result of the task.
result.result.personalDetails
Object
An object containing personal details of an individual.
result.result.personalDetails.constitutionType
String
The constitution type of the customer (e.g., individual, company, etc.).
result.result.personalDetails.accountHolderType
String
The type of account holder (if applicable).
result.result.personalDetails.ckycNumber
Number
The CKYC number of the customer.
result.result.personalDetails.prefix
String
The prefix of the customer's name.
result.result.personalDetails.firstName
String
The first name of the customer.
result.result.personalDetails.middleName
String
The middle name of the customer.
result.result.personalDetails.lastName
String
The last name of the customer.
result.result.personalDetails.fullName
String
The full name of the customer.
result.result.personalDetails.maidenPrefix
String
The maiden prefix of the customer (if applicable).
result.result.personalDetails.maidenFirstName
String
The maiden first name of the customer (if applicable).
result.result.personalDetails.maidenMiddleName
String
The maiden middle name of the customer (if applicable).
result.result.personalDetails.maidenLastName
String
The maiden last name of the customer (if applicable).
result.result.personalDetails.maidenFullName
String
The maiden full name of the customer (if applicable).
result.result.personalDetails.fatherSpouseFlag
String
The flag indicating whether the customer's father or spouse information is available.
result.result.personalDetails.fatherSpousePrefix
String
The prefix of the customer's father or spouse name.
result.result.personalDetails.fatherSpouseFirstName
String
The first name of the customer's father or spouse.
result.result.personalDetails.fatherSpouseMiddleName
String
The middle name of the customer's father or spouse.
result.result.personalDetails.fatherSpouseLastName
String
The last name of the customer's father or spouse.
result.result.personalDetails.fatherSpouseFullName
String
The full name of the customer's father or spouse.
result.result.personalDetails.motherPrefix
String
The prefix of the customer's mother name.
result.result.personalDetails.motherFirstName
String
The first name of the customer's mother.
result.result.personalDetails.motherMiddleName
String
The middle name of the customer's mother.
result.result.personalDetails.motherLastName
String
The last name of the customer's mother.
result.result.personalDetails.motherFullName
String
The full name of the customer's mother.
result.result.personalDetails.gender
String
The gender of the customer.
result.result.personalDetails.dob
String
The date of birth of the customer.
result.result.personalDetails.pan
String
The PAN (Permanent Account Number) of the customer.
result.result.personalDetails.formSixty
String
The Form 60 details of the customer.
result.result.personalDetails.address
Object
The address details of the customer.
result.result.personalDetails.address.permLine1
String
The first line of the permanent address of the customer.
result.result.personalDetails.address.permLine2
String
The second line of the permanent address of the customer.
result.result.personalDetails.address.permLine3
String
The third line of the permanent address of the customer.
result.result.personalDetails.address.permCity
String
The city of the permanent address of the customer.
result.result.personalDetails.address.permDistrict
String
The district of the permanent address of the customer.
result.result.personalDetails.address.permState
String
The state of the permanent address of the customer.
result.result.personalDetails.address.permCountry
String
The country of the permanent address of the customer.
result.result.personalDetails.address.permPin
Number
The PIN (Postal Index Number) of the permanent address of the customer.
result.result.personalDetails.address.permPoa
String
The proof of address document type for the permanent address of the customer.
result.result.personalDetails.address.permCorresFlag
String
The flag indicating whether the correspondence address is same as the permanent address.
result.result.personalDetails.address.corresLine1
String
The first line of the correspondence address of the customer (if applicable).
result.result.personalDetails.address.corresLine2
String
The second line of the correspondence address of the customer (if applicable).
result.result.personalDetails.address.corresLine3
String
The thrid line of the correspondence address of the customer (if applicable).
result.result.personalDetails.address.corresCity
String
The city of the correspondence address of the customer.
result.result.personalDetails.address.corresDistrict
String
The district of the correspondence address of the customer.
result.result.personalDetails.address.corresState
String
The state of the correspondence address of the customer.
result.result.personalDetails.address.corresCountry
String
The country of the correspondence address of the customer.
result.result.personalDetails.address.corresPin
Number
The PIN (Postal Index Number) of the correspondence address of the customer.
result.result.personalDetails.address.corresPoa
String
The proof of address document type for the correspondence address of the customer.
result.result.personalDetails.residenceStdCode
String
The residence standard code of the customer.
result.result.personalDetails.residenceTelephoneNumber
String
The residence telephone number of the customer.
result.result.personalDetails.officeStdCode
String
The office standard code of the customer.
result.result.personalDetails.officeTelephoneNumber
String
The office telephone number of the customer.
result.result.personalDetails.mobileCode
Number
The mobile country code of the customer.
result.result.personalDetails.mobileNumber
Number
The mobile number of the customer.
result.result.personalDetails.email
String
The email address of the customer.
result.result.personalDetails.remarks
String
Remarks (empty in this case)
result.result.personalDetails.declarationDate
String
Date of declaration
result.result.personalDetails.declarationPlace
String
Place of declaration
result.result.personalDetails.kycDate
String
Date of KYC 
result.result.personalDetails.documentSubmitted
String
The status of the documents submitted.
result.result.personalDetails.numberOfIdentity
Number
Number of identity proofs submitted
result.result.personalDetails.numberOfRelatedPersons
String
Number of related persons (empty in this case)
result.result.personalDetails.numberOfImages
Number
Number of images submitted
result.result.identityDetails
Array
The array contains the identity detailes of the customer.
result.result.identityDetails[0].sequenceNumber
Number
Sequence number of the identity detail
result.result.identityDetails[0].identityType
String
The type of identity of the customer.
result.result.identityDetails[0].identityNumber
String
The identity number of the customer
result.result.identityDetails[0].idVerificationStatus
String
The verification status of the ID of the customer.
result.result.imageDetails
Array
The array contains the image details.
result.result.imageDetails[0].sequenceNo
Number
Sequence number of the image details.
result.result.imageDetails[0].imageType
String
Type of the image
result.result.imageDetails[0].imageCode
String
Code of the image
result.result.imageDetails[0].globalFlag
String
Global flag of the image
result.result.imageDetails[0].branchCode
String
Branch code of the image
result.result.imageDetails[0].imageData
String
URL of the image
result.result.relatedPersonDetails
Array
Contains details of related persons to the customer.
200
400
401
404
409
500
// Invalid PartedId or InsurerId
{
    "error": {
        "name": "error",
        "message": "Please provide either PartnerId or InsurerId",
        "status": 400,
        "reason": "ERROR",
        "type": "Bad Request",
        "statusCode": 400
    }
}
// Invalid PartedId or InsurerId
{
    "error": {
        "name": "error",
        "message": "Please provide either PartnerId or InsurerId",
        "status": 400,
        "reason": "ERROR",
        "type": "Bad Request",
        "statusCode": 400
    }
}
﻿
﻿
Supporting ID type
idType
idNumber
A
Format: “Last 4 digits in Aadhaar Number|FirstName+ MiddleName + Lastname|DOB|Gender”.
Name cannot be more than 150 characters.
Date Of Birth  in format DD-MM-YYYY.
Gender can be M or F or T
Example: “0000|Ayush Kumar|23-02-1990|M”
P
Pan Number
D
Driving License
V
Voter ID
F
NREGA Job Card
G
National Population Register Letter
Z
CKYC Identifier
I
Certificate of Incorporation/Formation
R
Registration Certificate
PP
Passport Number
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!

CKYC Distributor Search

Hybrid Bank Account Verification

Docs powered by Archbee

TABLE OF CONTENTS

Request body parameters

Code samples

Response body parameters

Supporting ID type

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
insurerId	String	Unique identifier for the insurer. Please reach out to us at [email protected] to get the insurerId generated.	Mandatory
ckycNumber	String	14-digit Central KYC number associated with the individual.	Mandatory
authFactorType	String	The type of authentication to be used. For possible inputs, Refer to the table Authorization Factor Types below.	Mandatory
authFactorValue	String	The value associated with the authentication factor type used. For possible inputs, Refer to the table Authorization Factor Types below.	Mandatory

authFactorType	authFactorValue	authFactorValue-Format
01	Date of Birth of the Individual.	DD-MM-YYYY
02	Pincode of the registered address and Year of Birth.	XXXXXXYYYY Where XXXXXX is the Pincode and YYYY is the Birth Year.
03	10-digit Mobile number corresponding to the CKYC number.	0000000000

Parameter	Data Type	Description
result	Object	An object containing the result of the task.
result.result	Object	A nested object containing the result of the task.
result.result.personalDetails	Object	An object containing personal details of an individual.
result.result.personalDetails.constitutionType	String	The constitution type of the customer (e.g., individual, company, etc.).
result.result.personalDetails.accountHolderType	String	The type of account holder (if applicable).
result.result.personalDetails.ckycNumber	Number	The CKYC number of the customer.
result.result.personalDetails.prefix	String	The prefix of the customer's name.
result.result.personalDetails.firstName	String	The first name of the customer.
result.result.personalDetails.middleName	String	The middle name of the customer.
result.result.personalDetails.lastName	String	The last name of the customer.
result.result.personalDetails.fullName	String	The full name of the customer.
result.result.personalDetails.maidenPrefix	String	The maiden prefix of the customer (if applicable).
result.result.personalDetails.maidenFirstName	String	The maiden first name of the customer (if applicable).
result.result.personalDetails.maidenMiddleName	String	The maiden middle name of the customer (if applicable).
result.result.personalDetails.maidenLastName	String	The maiden last name of the customer (if applicable).
result.result.personalDetails.maidenFullName	String	The maiden full name of the customer (if applicable).
result.result.personalDetails.fatherSpouseFlag	String	The flag indicating whether the customer's father or spouse information is available.
result.result.personalDetails.fatherSpousePrefix	String	The prefix of the customer's father or spouse name.
result.result.personalDetails.fatherSpouseFirstName	String	The first name of the customer's father or spouse.
result.result.personalDetails.fatherSpouseMiddleName	String	The middle name of the customer's father or spouse.
result.result.personalDetails.fatherSpouseLastName	String	The last name of the customer's father or spouse.
result.result.personalDetails.fatherSpouseFullName	String	The full name of the customer's father or spouse.
result.result.personalDetails.motherPrefix	String	The prefix of the customer's mother name.
result.result.personalDetails.motherFirstName	String	The first name of the customer's mother.
result.result.personalDetails.motherMiddleName	String	The middle name of the customer's mother.
result.result.personalDetails.motherLastName	String	The last name of the customer's mother.
result.result.personalDetails.motherFullName	String	The full name of the customer's mother.
result.result.personalDetails.gender	String	The gender of the customer.
result.result.personalDetails.dob	String	The date of birth of the customer.
result.result.personalDetails.pan	String	The PAN (Permanent Account Number) of the customer.
result.result.personalDetails.formSixty	String	The Form 60 details of the customer.
result.result.personalDetails.address	Object	The address details of the customer.
result.result.personalDetails.address.permLine1	String	The first line of the permanent address of the customer.
result.result.personalDetails.address.permLine2	String	The second line of the permanent address of the customer.
result.result.personalDetails.address.permLine3	String	The third line of the permanent address of the customer.
result.result.personalDetails.address.permCity	String	The city of the permanent address of the customer.
result.result.personalDetails.address.permDistrict	String	The district of the permanent address of the customer.
result.result.personalDetails.address.permState	String	The state of the permanent address of the customer.
result.result.personalDetails.address.permCountry	String	The country of the permanent address of the customer.
result.result.personalDetails.address.permPin	Number	The PIN (Postal Index Number) of the permanent address of the customer.
result.result.personalDetails.address.permPoa	String	The proof of address document type for the permanent address of the customer.
result.result.personalDetails.address.permCorresFlag	String	The flag indicating whether the correspondence address is same as the permanent address.
result.result.personalDetails.address.corresLine1	String	The first line of the correspondence address of the customer (if applicable).
result.result.personalDetails.address.corresLine2	String	The second line of the correspondence address of the customer (if applicable).
result.result.personalDetails.address.corresLine3	String	The thrid line of the correspondence address of the customer (if applicable).
result.result.personalDetails.address.corresCity	String	The city of the correspondence address of the customer.
result.result.personalDetails.address.corresDistrict	String	The district of the correspondence address of the customer.
result.result.personalDetails.address.corresState	String	The state of the correspondence address of the customer.
result.result.personalDetails.address.corresCountry	String	The country of the correspondence address of the customer.
result.result.personalDetails.address.corresPin	Number	The PIN (Postal Index Number) of the correspondence address of the customer.
result.result.personalDetails.address.corresPoa	String	The proof of address document type for the correspondence address of the customer.
result.result.personalDetails.residenceStdCode	String	The residence standard code of the customer.
result.result.personalDetails.residenceTelephoneNumber	String	The residence telephone number of the customer.
result.result.personalDetails.officeStdCode	String	The office standard code of the customer.
result.result.personalDetails.officeTelephoneNumber	String	The office telephone number of the customer.
result.result.personalDetails.mobileCode	Number	The mobile country code of the customer.
result.result.personalDetails.mobileNumber	Number	The mobile number of the customer.
result.result.personalDetails.email	String	The email address of the customer.
result.result.personalDetails.remarks	String	Remarks (empty in this case)
result.result.personalDetails.declarationDate	String	Date of declaration
result.result.personalDetails.declarationPlace	String	Place of declaration
result.result.personalDetails.kycDate	String	Date of KYC
result.result.personalDetails.documentSubmitted	String	The status of the documents submitted.
result.result.personalDetails.numberOfIdentity	Number	Number of identity proofs submitted
result.result.personalDetails.numberOfRelatedPersons	String	Number of related persons (empty in this case)
result.result.personalDetails.numberOfImages	Number	Number of images submitted
result.result.identityDetails	Array	The array contains the identity detailes of the customer.
result.result.identityDetails[0].sequenceNumber	Number	Sequence number of the identity detail
result.result.identityDetails[0].identityType	String	The type of identity of the customer.
result.result.identityDetails[0].identityNumber	String	The identity number of the customer
result.result.identityDetails[0].idVerificationStatus	String	The verification status of the ID of the customer.
result.result.imageDetails	Array	The array contains the image details.
result.result.imageDetails[0].sequenceNo	Number	Sequence number of the image details.
result.result.imageDetails[0].imageType	String	Type of the image
result.result.imageDetails[0].imageCode	String	Code of the image
result.result.imageDetails[0].globalFlag	String	Global flag of the image
result.result.imageDetails[0].branchCode	String	Branch code of the image
result.result.imageDetails[0].imageData	String	URL of the image
result.result.relatedPersonDetails	Array	Contains details of related persons to the customer.

idType	idNumber
A	Format: “Last 4 digits in Aadhaar Number\|FirstName+ MiddleName + Lastname\|DOB\|Gender”. Name cannot be more than 150 characters. Date Of Birth in format DD-MM-YYYY. Gender can be M or F or T Example: “0000\|Ayush Kumar\|23-02-1990\|M”
P	Pan Number
D	Driving License
V	Voter ID
F	NREGA Job Card
G	National Population Register Letter
Z	CKYC Identifier
I	Certificate of Incorporation/Formation
R	Registration Certificate
PP	Passport Number