Bureau Consent Flow Encrypt Data
Introduction
This API is for giving demo on our api specs portal for Bureau consent flow. Client should integrate encryption/decryption in their application, all the required details will be shared on onboarding client with consent flow.
Authorization
- Authorization Token: Users require an authorization token generated by Signzy to use this API. Please contact [email protected] for acquiring this token.
Conclusion
In summary, the Initiate Bureau Consent API simplifies the initiation of Customer Consent for Bureau Credit Reports by providing a unique Consent Link. It streamlines the process of customer verification and ensures the secure transmission of Bureau Credit reports to the user's provided callback URL.
Sample Curl:
curl --location 'https://api-preproduction.signzy.app/api/v3/test-encrypt-data' \
--header 'Authorization: <auth-token>' \
--header 'Content-Type: application/json' \
--data '{
"phoneNumber": "",
"firstName": "",
"lastName":"",
"dateOfBirth": "1986-06-03",
"panNumber": "",
"gender": "",
"address": "",
"pincode": "",
"callbackUrl":"",
"productName":["equifax"],
"otpBypass":true,
"redirectUrl": "https://www.google.com/"
}'Input Parameters:
Parameter | Type | Mandatory/Optional | Description |
|---|---|---|---|
requestId | String | Mandatory | uuid generated from client's end |
phoneNumber | String | Mandatory | The phone number of the individual for whom the Bureau report is requested. |
panNumber | String | Mandatory. Optional for cibil bureau | The PAN (Permanent Account Number) of the individual. |
passport | String | Optional | passport Id |
voterId | String | Optional | Voter Id |
driversLicense | String | Optional | Drivers License Number |
firstName | String | Mandatory | The First Name of the individual. |
lastName | String | Mandatory | The Last Name of the individual |
gender | String | Mandatory | gender Male/Female/Transgender |
dateOfBirth | String | Mandatory | Date of Birth of the user yyyy-mm-dd |
address | String | Mandatory | Address of the user |
pincode | String | Mandatory | pincode of the user |
productName | Array | Mandatory | Bureau name list - cibil, equifax, experian, crif |
redirectUrl | String | Optional | Redirect page url |
callbackUrl | String | Mandatory | Callback url where report will be posted |
Sample Status Codes And Messages
{
"error": {
"name": "error",
"message": "Error in getting data from Upstream",
"status": 409,
"reason": "Error",
"type": "Conflict",
"statusCode": 409
}
}