CKYC Generate OTP API

CKYC Generate OTP API is a robust solution built to facilitate the secure and efficient retrieval of CKYC (Central Know Your Customer) records using CKYC number or newly introduced CKYC Alphanumeric Reference ID and an authentication factor. This API helps generate an OTP on the CKYC-registered mobile number, which is then used to fetch CKYC details through the CKYC Validate OTP API.

By submitting the CKYC number along with an authentication factor (such as date of birth), the API initiates an OTP-based authentication process. In the response, the last four digits of the mobile number are shared, helping the customer identify which registered number to check for the OTP. This ensures secure access while maintaining user awareness and control over the process.

Note: Please use your dedicated server endpoint in case this module is deployed on your server.

API details

Endpoint

POST https://api.signzy.app/api/v3/ckyc/generateOTP

POST https://api-preproduction.signzy.app/api/v3/ckyc/generateOTP

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
ckycNumber	String	Complete CKYC number or newly introduced CKYC Alphanumeric Reference ID received from CKYC Search API response	Mandatory
authFactorType	String	Type of the ID provided. For possible inputs, Refer to the table Supporting ID Types below.	Mandatory
authFactorValue		The value associated with the authentication factor type used. For possible inputs, Refer to the table Authorization Factor Types below.	Mandatory
maskAadhaar	Boolean	If enabled as True, the ID image documents with imageCode 04, 36, or 37 which belongs to Aadhaar ID type will be masked. All other images remain unchanged. The imageData in final response will have only the masked Aadhaar image and not the original one.	Optional (If required, you can pass it for Legal Entity records as their response comes in response of this API as they don't need OTP)
env	String	"preproduction" (Pass specifically "preproduction" only if you want to hit CERSAI Sandbox, else do not pass this field)	Optional

{
    "ckycNumber": "IMCJJB81160521",
    "authFactorType": "01",
    "authFactorValue": "02-09-1997",
    "maskAadhaar": true,
    "env": "preproduction" // Pass specifically preproduction only if you want to hit cersai preprod, else do not pass this field
}

Authorization Factor Types

authFactorType	authFactorValue	authFactorValue-Format
01	Date of Incorporation (for Legal Entity records)	DD-MM-YYYY
03	Mobile Number (for individual records as well as Legal Entity)	0000000000
04	Email (for Legal Entity records)
05	Pin code (for Legal Entity records)	XXXXXXYYYY Where XXXXXX is the Pincode and YYYY is the Birth Year.

Code samples

curl --location 'https://api.signzy.app/api/v3/ckyc/generateOTP' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Your access token>' \
--header 'X-Requested-Client: <Your request client id>' \
--data '{
    "ckycNumber": "INCJNB81160121",
    "authFactorType": "01",
    "authFactorValue": "02-09-1997",
    "maskAadhaar": true,
    "env": "preproduction"
}'

Response body parameters

Parameter	Data Type	Description
requestId	Object	A unique identifier for CKYC request
message	String	message of OTP generated

// Individual
{
   "requestId": "12345",
   "message": "OTP has been sent to the registered mobile number XXXXXX6045"
}

// Business
{
    "result": {
        "imageDetails": [
            {
                "branchCode": "",
                "sequenceNo": "1",
                "imageData": "/9j/XXX/2Q==",
                "globalFlag": "",
                "imageCode": "20",
                "imageType": "pdf"
            }
        ],
        "personalDetails": {
            "constitutionType": "D",
            "constitutionTypeOthers": "",
            "accountHolderType": "",
            "ckycNumber": "70062719671298",
            "referenceId": "LEVWXI96290429",
            "prefix": "",
            "firstName": "",
            "middleName": "",
            "lastName": "",
            "fullName": "Deo Lite PVT LIMITED",
            "placeOfIncorporation": "",
            "dateOfCommencementOfBusiness": "",
            "countryOfIncorporation": "",
            "tinGst": "",
            "tinCountry": "",
            "maidenPrefix": "",
            "maidenFirstName": "",
            "maidenMiddleName": "",
            "maidenLastName": "",
            "maidenFullName": "",
            "fatherSpouseFlag": "",
            "fatherSpousePrefix": "",
            "fatherSpouseFirstName": "",
            "fatherSpouseMiddleName": "",
            "fatherSpouseLastName": "",
            "fatherSpouseFullName": "",
            "motherPrefix": "",
            "motherFirstName": "",
            "motherMiddleName": "",
            "motherLastName": "",
            "motherFullName": "",
            "gender": "",
            "nationality": "",
            "dob": "06/01/1999",
            "pan": "KTCCK1239T",
            "formSixty": "",
            "disabilityFlag": "",
            "disabilityType": "",
            "disabilityPercent": "",
            "disabilityUDIDNumber": "",
            "address": {
                "resiStatus": "",
                "permLine1": "Jain nagar",
                "permLine2": "Addr2",
                "permLine3": "Addr3",
                "permCity": "Mumbai",
                "permDistrict": "Mumbai",
                "permState": "MH",
                "permCountry": "IN",
                "permPin": "400006",
                "permPoa": "06",
                "permPoaOthers": "",
                "permCorresFlag": "N",
                "corresLine1": "Corraddr1",
                "corresLine2": "Corraddr2",
                "corresLine3": "Corraddr3",
                "corresCity": "Mumbai",
                "corresDistrict": "Mumbai",
                "corresState": "MH",
                "corresCountry": "IN",
                "corresPin": "400006",
                "corresPoa": ""
            },
            "proofOfAddress": "",
            "residenceStdCode": "",
            "residenceTelephoneNumber": "",
            "officeStdCode": "",
            "officeTelephoneNumber": "",
            "faxCode": "",
            "faxNumber": "",
            "mobileCode1": "",
            "mobileNumber1": "",
            "mobileCode2": "",
            "mobileNumber2": "",
            "mobileCode": "",
            "mobileNumber": "",
            "email": "",
            "email2": "",
            "remarks": "",
            "declarationDate": "03/08/2023",
            "declarationPlace": "Sanghera",
            "kycDate": "********",
            "documentSubmitted": "01",
            "ipvFlag": "",
            "kycName": "********",
            "kycDesignation": "********",
            "kycBranch": "********",
            "kycEmpCode": "********",
            "numberOfIdentity": "1",
            "numberOfRelatedPersons": "4",
            "numberOfImages": "2",
            "organizationName": "",
            "organizationCode": "",
            "din": "",
            "relationshipTypeOthers": "",
            "relationshipTypeOthersDesc": ""
        },
        "relatedPersonDetails": [
            {
                "sequenceNo": "1",
                "relationshipType": "12",
                "addDelFlag": "1",
                "ckycNumber": "",
                "prefix": "Mr",
                "firstName": "Aditya",
                "middleName": "",
                "lastName": "Somani",
                "fullName": "",
                "maidenPrefix": "",
                "maidenFirstName": "",
                "maidenMiddleName": "",
                "maidenLastName": "",
                "maidenFullName": "",
                "fatherSpouseFlag": "01",
                "fatherSpousePrefix": "Mr",
                "fatherSpouseFirstName": "Ishaan",
                "fatherSpouseMiddleName": "",
                "fatherSpouseLastName": "Somani",
                "fatherSpouseFullName": "",
                "motherPrefix": "",
                "motherFirstName": "",
                "motherMiddleName": "",
                "motherLastName": "",
                "motherFullName": "",
                "dob": "28-07-1968",
                "gender": "M",
                "pan": "BCDPE1234V",
                "nationality": "",
                "formSixty": "",
                "disabilityFlag": "",
                "disabilityType": "",
                "disabilityPercent": "",
                "disabilityUDIDNumber": "",
                "residentialStatus": "",
                "residenceStdCode": "",
                "residenceTelephoneNumber": "",
                "officeStdCode": "",
                "officeTelephoneNumber": "",
                "mobileCode": "",
                "mobileNumber": "",
                "email": "",
                "declarationDate": "",
                "declarationPlace": "",
                "kycDate": "",
                "documentSubmitted": "",
                "kycName": "",
                "kycDesignation": "",
                "kycBranch": "",
                "kycEmpCode": "",
                "organizationName": "",
                "organizationCode": "",
                "din": "",
                "relationshipTypeOthers": "",
                "remarks": "",
                "photoType": "jpg",
                "photoData": "/9j/XXX/2Q==",
                "permPoiType": "JPG",
                "permPoiData": "/9j/XXX/2Q==",
                "corresPoiImageType": "",
                "corresPoiData": "",
                "proofOfPossessionOfAadhaar": "",
                "voterId": "",
                "nrega": "",
                "passport": "",
                "foreignNationalId": "",
                "drivingLicence": "",
                "nationalPopulationRegLetter": "",
                "offlineVerificationAadhaar": "",
                "eKycAuthentication": "",
                "address": {
                    "addLine1": "",
                    "addLine2": "",
                    "addLine3": "",
                    "addCity": "",
                    "addDistrict": "",
                    "addDist": "",
                    "addState": "",
                    "addCountry": "",
                    "addPin": "",
                    "permPoiType": "",
                    "sameAsPermFlag": "",
                    "permLine1": "",
                    "permLine2": "",
                    "permLine3": "",
                    "permCity": "",
                    "permDistrict": "",
                    "permState": "",
                    "permCountry": "",
                    "permPin": "",
                    "permPoa": "",
                    "permCorresFlag": "",
                    "corresAddLine1": "",
                    "corresAddLine2": "",
                    "corresAddLine3": "",
                    "corresAddCity": "",
                    "corresAddDistrict": "",
                    "corresAddDist": "",
                    "corresAddState": "",
                    "corresAddCountry": "",
                    "corresAddPin": "",
                    "corresPoiType": "",
                    "corresLine1": "",
                    "corresLine2": "",
                    "corresLine3": "",
                    "corresCity": "",
                    "corresDistrict": "",
                    "corresState": "",
                    "corresCountry": "",
                    "corresPin": "",
                    "corresPoa": ""
                }
            }
        ],
        "identityDetails": [
            {
                "sequenceNumber": "1",
                "identityType": "",
                "identityNumber": "U67190MH2000PTC124982",
                "idVerificationStatus": ""
            }
        ]
    }
}

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!