Initiate Bureau Consent Flow

Introduction

This API initiates Customer Consent for Fetching Credit Report from Bureau by generating a unique Consent Link. Users of this API can create consent requests on behalf of customers by submitting mailing addresses and/or mobile numbers. A notification containing a unique link will be sent to the provided contact details.

Upon successful completion of customer verification, the Credit Report will be sent to the user's provided callback URL.

Key Features

Customer Consent Initiation: Users can initiate Customer Consent for Credit Report by generating a unique Consent Link.

Encrypted Request and Response data: Users are required to encrypt the request data on their application. encryption/decryption details can be obtained from the team on api onboarding.

Notification: Notifications are sent to provided contact details along with the unique link for consent initiation.

Callback URL: Bureau Credit Reports are sent to the user's provided callback URL upon successful completion of customer verification.

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/create-bureau-consent' \
--header 'Authorization: <signzy-auth>' \
--header 'Content-Type: application/json' \
--data '{
    "requestData": "vgbxsBcmcIAv/Je4Seb6G7QahV92VM7fOST3xfVrqqF53VbW6x9dFnOAk/z0ozmdjZKv0kBf+J3GwqnaxSYuWBvDTY+81xG56ViK/h7GppBZpSmFU1S8+270TC2aAS9VTO+eOxsN1osPI5NDSK7vmLdh23x0+owHgq3H/EEacgnPVGhpotSd2XwjdKjTcv6wdkHWMTl7HXhm7hyLMUe871yKKioLVEfjTRj5hTx+gRzZqtzo7EX++GEI4vnBCXSEjFOE8YwzkJhJ+DklA1aVcDVbKbeDsLsB4V0Rh0zJof0NGFkMqiYgw9OHBpIPgCYCbkVKuH6I6AakCx5DQ8A3bnNViX8rLEPzqZkEyO0M90Fy1i6Tey++f7lA3ScroyW9+cSK9R5cjzsd4G44BgNo2dVeHTi0AOrYPYRI4AAkmizfAxAY3cH/iRX0WQaMqVlV5afTYz0pqMYapHyFybHkrS/MxEMi2ojTJM1Zt3vL/zt7vf98/Yf/sxXQ7NW0VDObQ8pqOeS44fO6lC8mib89llJMDvv23mVWvVN2iO1nqVPyB+i"
}'

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

{
  "referenceId": "b95d09e2-7be5-4dcb-a599-4f3de2b3e151",
  "requestId": "68cc01b3-6fd5-481a-865e-3327f6a2c224",
  "result": {
    "error": {
        "reason": "NOT_FOUND",
        "status": 200,
        "message": "No record found",
        "type": "Not Found",
        "statusCode": 404,
        "name": "error"
    }
  },
  "userConsent": {
    "consentObject": "",
    "timestamp": 1769243504244
  },
  "message": "User not present in bureau",
  "statusCode": 1
}