CKYC Download Legal

Endpoint Overview

POST /api/v1/ckyc-v2/download-legal

Description

The Download Legal Entity CKYC API enables businesses to retrieve comprehensive Know Your Customer (KYC) information for legal entities (companies, partnerships, trusts, etc.) from the Central KYC (CKYC) registry. This endpoint provides complete organizational details including identity documents, related persons (directors, partners, trustees), address information, and supporting documentation in base64-encoded format.

This API is essential for financial institutions, fintech companies, and regulated entities that need to perform due diligence on corporate customers. It retrieves the official CKYC records that have been verified and registered by regulated financial institutions, ensuring data authenticity and compliance with regulatory requirements.

Key Benefits

Comprehensive Entity Data: Access complete legal entity information including constitution type, incorporation details, and registered addresses

Related Persons Information: Retrieve details of all directors, partners, trustees, or authorized signatories associated with the entity

Document Access: Download identity proofs, address proofs, and photographs in base64-encoded format for verification purposes

Regulatory Compliance: Simplify KYC compliance by accessing centrally verified and authenticated entity records

Use Cases

Banking & Financial Services

Fintech & Lending

Insurance & Investment

Corporate account opening with automated KYC verification for business entities

Loan application processing for companies requiring comprehensive entity due diligence

Merchant onboarding for payment services requiring verification of business details

Credit limit assessment using verified corporate information and director details

Technical Implementation

Authentication

All API requests require authentication using a JWT Bearer token. Authentication follows these steps:

Obtain API Credentials: Register with Surepass to receive your API key.

Generate JWT Token: Use your API key to generate a JWT token for the respective environment.

Include in Requests: Add the token to the Authorization header as Bearer YOUR_JWT_TOKEN.

Different authentication tokens and base URLs are used for sandbox and production environments:

Sandbox: https://sandbox.surepass.app

Production: https://kyc-api.surepass.app

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	Bearer token for API authentication. Format: `Bearer YOUR_JWT_TOKEN`
Content-Type	Yes	Must be set to `application/json`

Request Body

Parameter	Type	Required	Description
client_id	string	Yes	Unique client identifier obtained from a previous CKYC search operation. Format: `ckyc_` followed by alphanumeric characters
dob	string	Yes	Date of birth or date of incorporation of the legal entity. Format: `YYYY-MM-DD` (e.g., "2006-05-24")

Example Request

{
  "client_id": "ckyc_YWECGljIfgTrlCaijVKf",
  "dob": "2006-05-24"
}

Process Response

Response Parameters

Parameter	Type	Description
data	object	Container object for all response data
data.client_id	string	Unique identifier for this download request
data.ckyc_search_client_id	string/null	Reference to the search operation client ID
data.dob	string/null	Date of birth/incorporation from the request
data.pincode	integer	Postal code associated with the entity
data.ckyc_download_data	object	Main container for all CKYC information
data.ckyc_download_data.record_counts	object	Statistics about the records
data.ckyc_download_data.record_counts.update_count	integer	Number of updates made to the CKYC record
data.ckyc_download_data.record_counts.download_count	integer	Number of times this record has been downloaded
data.ckyc_download_data.image_details	string	Base64-encoded image metadata
data.ckyc_download_data.related_persons	array	Array of related persons (directors, partners, trustees, etc.)
data.ckyc_download_data.identity_details	array	Array of identity documents for the entity
data.ckyc_download_data.personal_details	object	Complete details of the legal entity
status_code	integer	HTTP status code (200 for success)
success	boolean	Indicates whether the request was successful
message	string	Human-readable status message
message_code	string	Machine-readable message code

Each object in the related_persons array contains:

Field	Type	Description
full_name	string	Full name of the related person
father_full_name	string	Father's full name
mother_full_name	string	Mother's full name
prefix	string	Name prefix (Mr., Mrs., Ms., Dr., etc.)
dob	string	Date of birth in DD-MM-YYYY format
gender	string	Gender (M/F/O)
pan	string	PAN card number
nationality	string	Nationality code (e.g., "IN" for India)
din	integer	Director Identification Number (for directors)
mob_code	integer	Mobile country code
mob_num	string	Mobile number
email	string	Email address
address_line_1	string	Permanent address line 1
address_line_2	string	Permanent address line 2
address_line_3	string	Permanent address line 3
address_city	string	City name
address_state	string	State name
address_district	string	District name
address_pin	integer	PIN code
address_country	string	Country code
correspondence_address_line_1	string	Correspondence address line 1
correspondence_address_line_2	string	Correspondence address line 2
correspondence_address_line_3	string	Correspondence address line 3
correspondence_address_city	string	Correspondence city
correspondence_address_state	string	Correspondence state
correspondence_address_district	string	Correspondence district
correspondence_address_pin	integer	Correspondence PIN code
correspondence_address_country	string	Correspondence country code
same_as_permanent_address_flag	string	Indicates if correspondence address matches permanent address
relationship_type	integer	Type of relationship with entity (numeric code)
relationship_type_others	string	Other relationship type description
photo_type	string	Photo file type (jpg, png)
photo_data	string	Base64-encoded photograph
permanent_proof_of_identity_type	string	Type code for permanent address proof
permanent_proof_of_identity_image_type	string	Image type for proof document
permanent_proof_of_identity_data	string	Base64-encoded proof of identity document
Correspondence_proof_of_identity_type	integer	Type code for correspondence address proof
Correspondence_proof_of_identity_data	string/null	Base64-encoded correspondence proof document
offline_verification_aadhaar	string	Masked Aadhaar number
proof_of_possession_of_aadhaar	string	Masked Aadhaar number for verification
declaration_date	string	Date of declaration in DD-MM-YYYY format
declaration_place	string	Place where declaration was made
organization_code	string	Organization code (masked in response)
kyc_employee_code	string	KYC employee code (masked in response)
kyc_designation	string	Designation of KYC officer (masked in response)
kyc_name	string	Name of KYC officer (masked in response)
kyc_date	string	KYC verification date (masked in response)
kyc_branch	string	Branch where KYC was done (masked in response)
org_name	string	Organization name (masked in response)
sequence_no	integer	Sequence number of the person in the array
ckyc_no	string	CKYC number if available
doc_sub	integer	Document submission flag
add_del_flag	integer	Add/delete flag for record status
father_prefix	string	Father's name prefix
mother_prefix	string	Mother's name prefix
fatherspouse_flag	integer	Flag indicating father/spouse relationship
residence_status	string	Residence status
residential_std_code	string	Residential STD code
residential_telephone	string	Residential telephone number
off_std_code	string	Office STD code
off_tel_num	string	Office telephone number
maiden_full_name	string	Maiden name if applicable
disability_type	string	Type of disability if any
disability_percent	string	Disability percentage
disability_flag	string	Disability flag
disability_udid_number	string	Unique Disability ID
form_sixty	string	Form 60 details if applicable
remarks	string	Additional remarks

Identity Details Object Structure

Each object in the identity_details array contains:

Field	Type	Description
identity_number	string	Identity document number (e.g., CIN, Registration Number)
identity_type	string	Type of identity document
ident_type	integer	Numeric code for identity type
sequence_no	integer	Sequence number in the array

Personal Details Object Structure

Field	Type	Description
fullname	string	Full legal name of the entity
dob	string	Date of incorporation in DD-MM-YYYY format
pan	string	PAN card number of the entity
ckyc_number	string	CKYC registry number
ckyc_reference_id	string	CKYC reference identifier
constitution_type	string	Type of constitution (e.g., Private Limited Company, Partnership, Trust)
constitution_type_others	string	Other constitution type if not in standard list
consti_type	string	Constitution type code
country_of_incorporation	string	Country code where entity is incorporated
place_of_incorporation	string	City/place of incorporation
date_comm_bus	string	Date of commencement of business
tin_gst	string	GST/TIN number
gst_country	string	Country for GST registration
permanent_address_line_1	string	Registered address line 1
permanent_address_line_2	string	Registered address line 2
permanent_address_line_3	string	Registered address line 3
permanent_address_city	string	Registered city
permanent_address_state	string	Registered state
permanent_address_district	string	Registered district
permanent_address_pin	integer	Registered PIN code
permanent_address_country	string	Registered country code
correspondence_address_line_1	string	Correspondence address line 1
correspondence_address_line_2	string	Correspondence address line 2
correspondence_address_line_3	string	Correspondence address line 3
correspondence_address_city	string	Correspondence city
correspondence_address_state	string	Correspondence state
correspondence_address_district	string	Correspondence district
correspondence_address_pin	integer	Correspondence PIN code
correspondence_address_country	string	Correspondence country code
same_as_permanent_address	string	Indicates if addresses are same
email	string	Primary email address
email_secondary	string	Secondary email address
mobile_number	string	Primary mobile number
mobile_number_secondary	string	Secondary mobile number
mobile_code	integer	Mobile country code
mobile_code_secondary	integer	Secondary mobile country code
fax_code	string	Fax country code
fax_number	string	Fax number
office_std_code	string	Office STD code
office_phone_number	string	Office phone number
proof_of_address	string	Proof of address type
permanent_proof_of_address	string	Permanent address proof type
permanent_proof_of_address_others	string	Other permanent address proof details
correspondence_proof_of_address	string	Correspondence address proof type
total_identity_records	integer	Count of identity documents
total_image_records	string	Count/details of image records
total_related_persons	integer	Count of related persons
declaration_date	string	Declaration date in DD-MM-YYYY format
declaration_place	string	Place of declaration
organization_name	string	Organization name (masked in response)
organization_code	string	Organization code (masked in response)
kyc_employee_code	string	KYC employee code (masked in response)
kyc_branch	string	KYC branch (masked in response)
kyc_name	string	KYC officer name (masked in response)
kyc_date	string	KYC date (masked in response)
kyc_designation	string	KYC officer designation (masked in response)
ipv_flag	integer	In-Person Verification flag
doc_sub	integer	Document submission flag
remarks	string	Additional remarks

Example Successful Response

{
  "data": {
    "client_id": "ckyc_download_legal_Ldyu",
    "ckyc_search_client_id": null,
    "dob": "2006-05-24",
    "pincode": 110001,
    "ckyc_download_data": {
      "record_counts": {
        "update_count": 1,
        "download_count": 8
      },
      "image_details": "aGVsbG8=",
      "related_persons": [
        {
          "full_name": "Rahul Kumar",
          "father_full_name": "Mahesh Kumar",
          "mother_full_name": "Anita",
          "maiden_full_name": "",
          "residence_status": "",
          "residential_std_code": "",
          "residential_telephone": "",
          "address_line_1": "Sample Address",
          "address_line_2": "Sample Address",
          "address_line_3": "Sample Address",
          "address_district": "Sample Address",
          "address_city": "Sample Address",
          "address_state": "Sample Address",
          "address_pin": 110001,
          "address_country": "IN",
          "same_as_permanent_address_flag": "Sample Address",
          "relationship_type": 4,
          "relationship_type_others": "",
          "declaration_date": "10-08-2022",
          "organization_code": "********",
          "kyc_employee_code": "********",
          "declaration_place": "New Delhi",
          "permanent_proof_of_identity_type": "10",
          "permanent_proof_of_identity_image_type": "aGVsbG8=",
          "permanent_proof_of_identity_data": "/9j/4AAQSkZJRgABAQEAlgCWAAD/2wBDABALDA4",
          "correspondence_address_line_1": "Sample Address",
          "correspondence_address_line_2": "Sample Address",
          "correspondence_address_line_3": "Sample Address",
          "correspondence_address_city": "Sample Address",
          "correspondence_address_state": "Sample Address",
          "correspondence_address_district": "Sample Address",
          "correspondence_address_pin": 110001,
          "correspondence_address_country": "IN",
          "Correspondence_proof_of_identity_type": 10,
          "Correspondence_proof_of_identity_data": null,
          "disability_type": "",
          "disability_percent": "",
          "disability_flag": "",
          "disability_udid_number": "",
          "kyc_designation": "********",
          "prefix": "MR",
          "din": 8036863,
          "offline_verification_aadhaar": "XXXXXXXX1234",
          "off_std_code": "",
          "father_prefix": "MR",
          "fatherspouse_flag": 1,
          "mob_code": 91,
          "photo_type": "jpg",
          "kyc_name": "********",
          "off_tel_num": "",
          "pan": "ABCDE1234F",
          "mother_prefix": "MR",
          "photo_data": "/9j/4AAQSkZJRgABAQEAlgCWAAD/2wBDABALDA",
          "kyc_date": "********",
          "nationality": "IN",
          "dob": "29-02-1996",
          "doc_sub": 1,
          "gender": "M",
          "mob_num": "9876543210",
          "add_del_flag": 1,
          "kyc_branch": "********",
          "ckyc_no": "",
          "org_name": "********",
          "email": "user@example.com",
          "form_sixty": "",
          "sequence_no": 1,
          "remarks": ""
        }
      ],
      "identity_details": [
        {
          "identity_number": "U72900DL2019PTC349962",
          "identity_type": "Certificate of Incorporation/Formation",
          "ident_type": 2,
          "sequence_no": 1
        }
      ],
      "personal_details": {
        "fullname": "ABC PRIVATE LIMITED",
        "dob": "10-05-2019",
        "pan": "ABCDE1234F",
        "ipv_flag": 1,
        "remarks": "",
        "permanent_address_line_1": "Sample Address",
        "permanent_address_line_2": "Sample Address",
        "permanent_address_line_3": "Sample Address",
        "permanent_address_district": "Sample Address",
        "permanent_address_city": "Sample Address",
        "permanent_address_state": "Sample Address",
        "permanent_address_pin": 110001,
        "permanent_address_country": "IN",
        "correspondence_address_line_1": "Sample Address",
        "correspondence_address_line_2": "Sample Address",
        "correspondence_address_line_3": "Sample Address",
        "correspondence_address_district": "Sample Address",
        "correspondence_address_city": "Sample Address",
        "correspondence_address_state": "Sample Address",
        "correspondence_address_pin": 110001,
        "correspondence_address_country": "IN",
        "same_as_permanent_address": "Sample Address",
        "email": "user@example.com",
        "email_secondary": "user@example.com",
        "mobile_number": "9876543210",
        "mobile_number_secondary": "",
        "mobile_code": 91,
        "mobile_code_secondary": "",
        "fax_code": "",
        "fax_number": "",
        "office_std_code": "",
        "office_phone_number": "",
        "declaration_date": "16-08-2023",
        "declaration_place": "Kamla Nagar Branch New Delhi",
        "organization_name": "********",
        "organization_code": "********",
        "kyc_employee_code": "********",
        "kyc_branch": "********",
        "kyc_name": "********",
        "kyc_date": "********",
        "constitution_type": "Private Limited Company",
        "constitution_type_others": "",
        "proof_of_address": "Sample Address",
        "permanent_proof_of_address": "Sample Address",
        "permanent_proof_of_address_others": "Sample Address",
        "correspondence_proof_of_address": "Sample Address",
        "total_identity_records": 1,
        "total_image_records": "aGVsbG8=",
        "total_related_persons": 4,
        "ckyc_number": "80024980223909",
        "ckyc_reference_id": "LEFILB20063639",
        "gst_country": "",
        "country_of_incorporation": "IN",
        "place_of_incorporation": "NORTH DELHI",
        "kyc_designation": "********",
        "date_comm_bus": "10-05-2019",
        "consti_type": "D",
        "doc_sub": 1,
        "tin_gst": ""
      }
    }
  },
  "status_code": 200,
  "success": true,
  "message": "Success",
  "message_code": "success"
}

Possible Error Responses

Invalid Client ID

Authentication Error

{
  "data": null,
  "status_code": 400,
  "success": false,
  "message": "Invalid client_id provided",
  "message_code": "invalid_client_id"
}

This error occurs when the provided client_id is not found or is invalid. Ensure you're using a valid client_id obtained from a previous CKYC search operation.

Integration Best Practices

Security Recommendations

Secure Token Storage: Store JWT tokens securely using environment variables or secure vault solutions. Never hardcode tokens in your application code.

Token Rotation: Implement token refresh mechanisms and rotate tokens periodically to minimize security risks.

HTTPS Only: Always use HTTPS for API calls to ensure data encryption in transit. Never make calls over HTTP.

Data Encryption: Store downloaded CKYC data in encrypted databases with proper access controls. Implement encryption at rest for sensitive information.

Access Logging: Maintain comprehensive audit logs of all CKYC download operations including user, timestamp, and purpose for compliance requirements.

Rate Limiting: Implement rate limiting on your end to prevent abuse and ensure fair usage of the API.

Base64 Decoding: When handling base64-encoded documents and images, decode them securely and validate file types before storage or display.

User Experience Guidelines

Progress Indicators: Display loading indicators while fetching CKYC data as the response may contain large base64-encoded documents.

Data Validation: Validate the completeness of downloaded data before proceeding with business workflows. Check for mandatory fields based on your use case.

Error Handling: Implement graceful error handling with user-friendly messages. Guide users on corrective actions for common errors like date mismatches.

Image Display: Decode and display photo_data and document images in appropriate formats for verification purposes. Implement image preview functionality.

Related Persons View: Present related persons information in a structured, easy-to-navigate format with search and filter capabilities for entities with multiple directors/partners.

Data Refresh: Provide options to refresh CKYC data periodically for entities to ensure information remains current.

Document Download: Enable users to download identity proofs and address proofs as separate files for record-keeping and verification.

Code Samples

cURL

Python

Node.js

Related APIs

CKYC Search Legal API - Search for legal entities in the CKYC database using PAN, CIN, or entity name to obtain the client_id required for this download endpoint.

CKYC Download Individual API - Download complete KYC information for individual customers from the CKYC registry for personal account opening and verification.

PAN Verification API - Verify PAN details of legal entities and related persons independently for additional validation layers.

GST Verification API - Cross-verify GST numbers mentioned in CKYC data to ensure business authenticity and active tax registration status.

Company Master Data API - Fetch additional company information from MCA records to supplement CKYC data for comprehensive due diligence.

Compliance and Legal Considerations

Regulatory Framework: This API accesses data from the Central KYC Records Registry (CKYCR) established under the Prevention of Money Laundering (PML) Rules. Usage must comply with PMLA regulations and RBI guidelines.

Data Privacy: Downloaded CKYC data contains sensitive personal information of directors, partners, and other related persons. Ensure compliance with data protection laws including the Digital Personal Data Protection Act (DPDP) and implement appropriate data security measures.

Purpose Limitation: CKYC data should only be used for legitimate KYC and customer due diligence purposes. Unauthorized use, sharing, or selling of this data is prohibited and may result in legal consequences.

Consent Requirements: Ensure proper customer consent is obtained before downloading and processing their CKYC information. Maintain records of consent for audit purposes.

Data Retention: Implement data retention policies in accordance with regulatory requirements. Typically, KYC records must be retained for at least 5 years after the business relationship ends.

Audit Trail: Maintain comprehensive audit logs of all CKYC download operations including the purpose, user, and timestamp for regulatory inspections.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/ckyc-v2/download-legal' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "client_id": "ckyc_YWFCGlkIedJflCaijVKf", "dob": "2006-05-24" }'

{ "data": { "client_id": "ckyc_download_legal_LdyuJkgjsuS", "ckyc_search_client_id": null, "dob": "2006-05-24", "pincode": 110001, "ckyc_download_data": { "record_counts": { "update_count": 1, "download_count": 8 }, "image_details": "aGVsbG8=", "related_persons": [ { "full_name": "Rahul Kumar", "father_full_name": "Mahesh Kumar", "mother_full_name": "Anita", "maiden_full_name": "", "residence_status": "", "residential_std_code": "", "residential_telephone": "", "address_line_1": "Sample Address", "address_line_2": "Sample Address", "address_line_3": "Sample Address", "address_district": "Sample Address", "address_city": "Sample Address", "address_state": "Sample Address", "address_pin": 110001, "address_country": "IN", "same_as_permanent_address_flag": "Sample Address", "relationship_type": 4, "relationship_type_others": "", "declaration_date": "10-08-2022", "organization_code": "********", "kyc_employee_code": "********", "declaration_place": "New Delhi", "permanent_proof_of_identity_type": "10", "permanent_proof_of_identity_image_type": "aGVsbG8=", "permanent_proof_of_identity_data": "/9j/4AAQSkZJRgABAQEAlgCWAAD/2wBDABALDA4", "correspondence_address_line_1": "Sample Address", "correspondence_address_line_2": "Sample Address", "correspondence_address_line_3": "Sample Address", "correspondence_address_city": "Sample Address", "correspondence_address_state": "Sample Address", "correspondence_address_district": "Sample Address", "correspondence_address_pin": 110001, "correspondence_address_country": "IN", "Correspondence_proof_of_identity_type": 10, "Correspondence_proof_of_identity_data": null, "disability_type": "", "disability_percent": "", "disability_flag": "", "disability_udid_number": "", "kyc_designation": "********", "prefix": "MR", "din": 8036863, "offline_verification_aadhaar": "XXXXXXXX1234", "off_std_code": "", "father_prefix": "MR", "fatherspouse_flag": 1, "mob_code": 91, "photo_type": "jpg", "kyc_name": "********", "off_tel_num": "", "pan": "ABCDE1234F", "mother_prefix": "MR", "photo_data": "/9j/4AAQSkZJRgABAQEAlgCWAAD/2wBDABALDA", "kyc_date": "********", "nationality": "IN", "dob": "29-02-1996", "doc_sub": 1, "gender": "M", "mob_num": "9876543210", "add_del_flag": 1, "kyc_branch": "********", "ckyc_no": "", "org_name": "********", "email": "user@example.com", "form_sixty": "", "sequence_no": 1, "remarks": "" }, { "full_name": "Viren Singh", "father_full_name": "Deepak Kumar", "mother_full_name": "Pooja", "maiden_full_name": "", "residence_status": "", "residential_std_code": "", "residential_telephone": "", "address_line_1": "Sample Address", "address_line_2": "Sample Address", "address_line_3": "Sample Address", "address_district": "Sample Address", "address_city": "Sample Address", "address_state": "Sample Address", "address_pin": 110001, "address_country": "IN", "same_as_permanent_address_flag": "Sample Address", "relationship_type": 4, "relationship_type_others": "", "declaration_date": "10-08-2022", "organization_code": "********", "kyc_employee_code": "********", "declaration_place": "New Delhi", "permanent_proof_of_identity_type": "10", "permanent_proof_of_identity_image_type": "aGVsbG8=", "permanent_proof_of_identity_data": "/9j/4AAQSkZJRgABAQEAlgCWAAD/2wBDABALDA4M", "correspondence_address_line_1": "Sample Address", "correspondence_address_line_2": "Sample Address", "correspondence_address_line_3": "Sample Address", "correspondence_address_city": "Sample Address", "correspondence_address_state": "Sample Address", "correspondence_address_district": "Sample Address", "correspondence_address_pin": 110001, "correspondence_address_country": "IN", "Correspondence_proof_of_identity_type": 10, "Correspondence_proof_of_identity_data": null, "disability_type": "", "disability_percent": "", "disability_flag": "", "disability_udid_number": "", "kyc_designation": "********", "prefix": "MR", "din": 8272605, "offline_verification_aadhaar": "XXXXXXXX1234", "off_std_code": "", "father_prefix": "MR", "fatherspouse_flag": 1, "mob_code": 91, "photo_type": "jpg", "kyc_name": "********", "off_tel_num": "", "pan": "ABCDE1234F", "mother_prefix": "MR", "photo_data": "/9j/4AAQSkZJRgABAQEAlgCWAAD/2wBDABALDA4M", "kyc_date": "********", "nationality": "IN", "dob": "23-11-1996", "doc_sub": 1, "gender": "M", "mob_num": "9876543210", "add_del_flag": 1, "kyc_branch": "********", "ckyc_no": "", "org_name": "********", "email": "user@example.com", "form_sixty": "", "sequence_no": 2, "remarks": "" }, { "full_name": "Viren Singh", "father_full_name": "Deepak Kumar", "mother_full_name": "Pooja", "maiden_full_name": "", "residence_status": "", "residential_std_code": "", "residential_telephone": "", "address_line_1": "Sample Address", "address_line_2": "Sample Address", "address_line_3": "Sample Address", "address_district": "Sample Address", "address_city": "Sample Address", "address_state": "Sample Address", "address_pin": 110001, "address_country": "IN", "same_as_permanent_address_flag": "Sample Address", "relationship_type": 4, "relationship_type_others": "", "declaration_date": "16-08-2023", "organization_code": "********", "kyc_employee_code": "********", "declaration_place": "Kamla Nagar Branch New Delhi", "permanent_proof_of_identity_type": "1", "permanent_proof_of_identity_image_type": "aGVsbG8=", "permanent_proof_of_identity_data": "SUkqAOgxAQD/2P/BAAsIBtoE2Q", "correspondence_address_line_1": "Sample Address", "correspondence_address_line_2": "Sample Address", "correspondence_address_line_3": "Sample Address", "correspondence_address_city": "Sample Address", "correspondence_address_state": "Sample Address", "correspondence_address_district": "Sample Address", "correspondence_address_pin": 110001, "correspondence_address_country": "IN", "Correspondence_proof_of_identity_type": 1, "Correspondence_proof_of_identity_data": null, "disability_type": "", "disability_percent": "", "disability_flag": "", "disability_udid_number": "", "kyc_designation": "********", "prefix": "Mr.", "din": 8272605, "off_std_code": "", "father_prefix": "Mr.", "fatherspouse_flag": 1, "mob_code": 91, "photo_type": "jpg", "kyc_name": "********", "off_tel_num": "", "pan": "ABCDE1234F", "mother_prefix": "Mrs.", "photo_data": "/9j/4AAQSkZJRgABAQEAyADIAAD/2wCEAB", "kyc_date": "********", "nationality": "IN", "dob": "23-11-1996", "doc_sub": 1, "gender": "M", "mob_num": "9876543210", "add_del_flag": 1, "proof_of_possession_of_aadhaar": "XXXXXXXX1234", "kyc_branch": "********", "ckyc_no": "", "org_name": "********", "email": "user@example.com", "form_sixty": "", "sequence_no": 3, "remarks": "" }, { "full_name": "Rahul Kumar", "father_full_name": "Mahesh Kumar", "mother_full_name": "Anita", "maiden_full_name": "", "residence_status": "", "residential_std_code": "", "residential_telephone": "", "address_line_1": "Sample Address", "address_line_2": "Sample Address", "address_line_3": "Sample Address", "address_district": "Sample Address", "address_city": "Sample Address", "address_state": "Sample Address", "address_pin": 110001, "address_country": "IN", "same_as_permanent_address_flag": "Sample Address", "relationship_type": 4, "relationship_type_others": "", "declaration_date": "16-08-2023", "organization_code": "********", "kyc_employee_code": "********", "declaration_place": "Kamla Nagar Branch New Delhi", "permanent_proof_of_identity_type": "1", "permanent_proof_of_identity_image_type": "aGVsbG8=", "permanent_proof_of_identity_data": "SUkqAGrJAAD/2P/BAAsI", "correspondence_address_line_1": "Sample Address", "correspondence_address_line_2": "Sample Address", "correspondence_address_line_3": "Sample Address", "correspondence_address_city": "Sample Address", "correspondence_address_state": "Sample Address", "correspondence_address_district": "Sample Address", "correspondence_address_pin": 110001, "correspondence_address_country": "IN", "Correspondence_proof_of_identity_type": 1, "Correspondence_proof_of_identity_data": null, "disability_type": "", "disability_percent": "", "disability_flag": "", "disability_udid_number": "", "kyc_designation": "********", "prefix": "Mr.", "din": 8986863, "off_std_code": "", "father_prefix": "Mr.", "fatherspouse_flag": 1, "mob_code": 91, "photo_type": "jpg", "kyc_name": "********", "off_tel_num": "", "pan": "ABCDE1234F", "mother_prefix": "Mrs.", "photo_data": "/9j/4AAQSkZJRgABAQEAyADIAAD", "kyc_date": "********", "nationality": "IN", "dob": "29-02-1996", "doc_sub": 1, "gender": "M", "mob_num": "9876543210", "add_del_flag": 1, "proof_of_possession_of_aadhaar": "XXXXXXXX1234", "kyc_branch": "********", "ckyc_no": "", "org_name": "********", "email": "user@example.com", "form_sixty": "", "sequence_no": 4, "remarks": "" } ], "identity_details": [ { "identity_number": "U72900DL2019PTC349962", "identity_type": "Certificate of Incorporation/Formation", "ident_type": 2, "sequence_no": 1 } ], "personal_details": { "fullname": "ABC PRIVATE LIMITED", "dob": "10-05-2019", "pan": "ABCDE1234F", "ipv_flag": 1, "remarks": "", "permanent_address_line_1": "Sample Address", "permanent_address_line_2": "Sample Address", "permanent_address_line_3": "Sample Address", "permanent_address_district": "Sample Address", "permanent_address_city": "Sample Address", "permanent_address_state": "Sample Address", "permanent_address_pin": 110001, "permanent_address_country": "IN", "correspondence_address_line_1": "Sample Address", "correspondence_address_line_2": "Sample Address", "correspondence_address_line_3": "Sample Address", "correspondence_address_district": "Sample Address", "correspondence_address_city": "Sample Address", "correspondence_address_state": "Sample Address", "correspondence_address_pin": 110001, "correspondence_address_country": "IN", "same_as_permanent_address": "Sample Address", "email": "user@example.com", "email_secondary": "user@example.com", "mobile_number": "9876543210", "mobile_number_secondary": "", "mobile_code": 91, "mobile_code_secondary": "", "fax_code": "", "fax_number": "", "office_std_code": "", "office_phone_number": "", "declaration_date": "16-08-2023", "declaration_place": "Kamla Nagar Branch New Delhi", "organization_name": "********", "organization_code": "********", "kyc_employee_code": "********", "kyc_branch": "********", "kyc_name": "********", "kyc_date": "********", "constitution_type": "Private Limited Company", "constitution_type_others": "", "proof_of_address": "Sample Address", "permanent_proof_of_address": "Sample Address", "permanent_proof_of_address_others": "Sample Address", "correspondence_proof_of_address": "Sample Address", "total_identity_records": 1, "total_image_records": "aGVsbG8=", "total_related_persons": 4, "ckyc_number": "80024980223909", "ckyc_reference_id": "LEFILB20063639", "gst_country": "", "country_of_incorporation": "IN", "place_of_incorporation": "NORTH DELHI", "kyc_designation": "********", "date_comm_bus": "10-05-2019", "consti_type": "D", "doc_sub": 1, "tin_gst": "" } } }, "status_code": 200, "success": true, "message": "Success", "message_code": "success" }

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Example Request#

Response Parameters#

Related Persons Object Structure#

Identity Details Object Structure#

Personal Details Object Structure#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses