--- title: Initiate Credit Analytics - Consent Flow slug: api-marketplace/initiate-credit-analytics-consent-flow createdAt: 2023-12-08T06:16:39.746Z --- ### Introduction This API initiates Customer Consent for Fetching Credit Analytics 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 Analytics will be sent to the user's provided callback URL. ### Key Features - **Customer Consent Initiation**: Users can initiate Customer Consent for Credit Analytics 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**: Credit Analytics 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 help\@signzy.com for acquiring this token. ### Conclusion In summary, the Initiate Credit Analytics Consent API simplifies the initiation of Customer Consent for Credit Analytics by providing a unique Consent Link. It streamlines the process of customer verification and ensures the secure transmission of Credit Analytics to the user's provided callback URL. ## Sample Curl: :::CodeblockTabs preproduction ```curl curl --location 'https://api-preproduction.signzy.app/api/v3/create-bureau-consent' \ --header 'Authorization: ' \ --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" }' ``` Production ```curl curl --location 'https://api.signzy.app/api/v3/create-bureau-consent' \ --header 'Authorization: ' \ --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/UPjtnXdKPxKVzEVJIY0OTlQf9enEuE+022ZTTA==:YGeIJco8RTHYiqtmoJTulA==" }' ``` ::: ## 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 :::CodeblockTabs 200 OK ```json { "responseData": "2TpPddgMePqQrhVoPZxnsk0Q+fNQ1QGb+ukMColhhiL6G5SI/Rrts04mKKzN4/j5C55+VDR7eJyZeaxPleUUD6QlXF3l8torxGCigwP0MzPeInhfBifb4LZ73FoVKJfeBn3k3auWIy0JocN05DbNwlr/Io56Ro3YYs/5Sf/h6IGah3yqlm2Sp8JlZ4qPhHx0eWwFDh9CHRyOwbYFpUtgWg==:qaV3AK8ICFWw03+WBv/50A==" } ``` 409 ```json { "error": { "name": "error", "message": "Error in getting data from Upstream", "status": 409, "reason": "Error", "type": "Conflict", "statusCode": 409 } } ``` 400 ```json { "error": { "reason": "VALIDATION_ERROR", "status": 400, "message": "Encrypted string is invalid", "type": "Bad Request", "statusCode": 400, "name": "error" } } 1. Datatype validation issues errors, eg: "\"requestData\" must be a string" 2. Missing required parameters, eg: "\"requestData\" is required" ``` 401 ```json { "message": "Invalid authentication credentials" } ``` 500 ```json { "error": { "name": "error", "message": "Internal Server Error", "status": 500, "reason": "ERROR", "type": "Internal Server Error", "statusCode": 500 } } ``` decrypted consent api response ```json { "result": { "referenceId": "32d303ee-4d07-4a55-b0d6-b06f54b15c5b", "url": "https://tinyurl.com/22zazzwd", "requestId": "449c6147-7191-4a65-81dc-e28faf7e1228", "smsStatus": "OTP Bypass Enabled", "emailStatus": "OTP Bypass Enabled" } } ``` decrypted callback report data ```json { "referenceId": "b95d09e2-7be5-4dcb-a599-4f3de2b3e151", "requestId": "68cc01b3-6fd5-481a-865e-3327f6a2c224", "result": { "CIBILReport": { "currentversion": "5.0", "Borrower": { "Birth": { "date": "1989-06-29+05:30", "partitionSet": "0", "BirthDate": { "month": "6", "year": "1989", "day": "29" }, "Source": { "Reference": "0060ae2b-8a43-4276-8c0e-e049d01c3168", "InquiryDate": "2025-11-06+05:30", "Locale": "en_IN", "Bureau": { "symbol": "CIBIL", "description": "", "rank": "100000", "abbreviation": "" } }, "age": "0" }, "BorrowerAddress": { "Dwelling": { "symbol": "01", "description": "", "rank": "100000", "abbreviation": "" }, "Ownership": { "symbol": "01", "description": "", "rank": "100000", "abbreviation": "" }, "addressOrder": "0", "dateReported": "2024-07-22+05:30", "partitionSet": "0", "CreditAddress": { "SerialNumber": "99116360865", "AddressType": "", "StreetAddress": "S. V. ROAD, SAVARKAR COLONY", "City": "", "PostalCode": "400043", "Region": "27" }, "Origin": { "symbol": "ICICI BANK LICENCECANCELLED", "description": "", "rank": "100000", "abbreviation": "" }, "enrichMode": "R", "Source": { "Reference": "0060ae2b-8a43-4276-8c0e-e049d01c3168", "InquiryDate": "2025-11-06+05:30", "Locale": "en_IN", "Bureau": { "symbol": "CIBIL", "description": "", "rank": "100000", "abbreviation": "" } } }, "CreditScore": { "CreditScoreModel": { "symbol": "CIBILTUSC3", "description": "", "rank": "100000", "abbreviation": "" }, "CreditScoreFactor": [ { "bureauCode": "00", "Factor": { "symbol": "00", "description": "", "rank": "100000", "abbreviation": "" }, "FactorText": [ "No Valid Factors", "We're sorry, but the adverse factors affecting your Credit Score are currently unavailable. Factors that may affect your score include: payment history, outstanding debt, credit account history, recent inquiries, types of credit and other features such as bankruptcies and collection accounts." ] }, { "bureauCode": "00", "Factor": { "symbol": "00", "description": "", "rank": "100000", "abbreviation": "" }, "FactorText": [ "No Valid Factors", "We're sorry, but the adverse factors affecting your Credit Score are currently unavailable. Factors that may affect your score include: payment history, outstanding debt, credit account history, recent inquiries, types of credit and other features such as bankruptcies and collection accounts." ] }, { "bureauCode": "00", "Factor": { "symbol": "00", "description": "", "rank": "100000", "abbreviation": "" }, "FactorText": [ "No Valid Factors", "We're sorry, but the adverse factors affecting your Credit Score are currently unavailable. Factors that may affect your score include: payment history, outstanding debt, credit account history, recent inquiries, types of credit and other features such as bankruptcies and collection accounts." ] }, { "bureauCode": "00", "Factor": { "symbol": "00", "description": "", "rank": "100000", "abbreviation": "" }, "FactorText": [ "No Valid Factors", "We're sorry, but the adverse factors affecting your Credit Score are currently unavailable. Factors that may affect your score include: payment history, outstanding debt, credit account history, recent inquiries, types of credit and other features such as bankruptcies and collection accounts." ] }, { "bureauCode": "00", "Factor": { "symbol": "00", "description": "", "rank": "100000", "abbreviation": "" }, "FactorText": [ "No Valid Factors", "We're sorry, but the adverse factors affecting your Credit Score are currently unavailable. Factors that may affect your score include: payment history, outstanding debt, credit account history, recent inquiries, types of credit and other features such as bankruptcies and collection accounts." ] } ], "NoScoreReason": { "symbol": "", "description": "", "rank": "100000", "abbreviation": "" }, "riskScore": "727", "populationRank": "22", "Source": { "Reference": "0060ae2b-8a43-4276-8c0e-e049d01c3168", "InquiryDate": "2025-11-06+05:30", "Locale": "en_IN", "Bureau": { "symbol": "CIBIL", "description": "", "rank": "100000", "abbreviation": "" } }, "scoreName": "CIBILTransUnionScore3" }, "Employer": { "income": "87529.0", "serialNumber": "99947270698", "IncomeFreqIndicator": { "symbol": "M", "description": "Monthly", "rank": "100000", "abbreviation": "" }, "NetGrossIndicator": { "symbol": "N", "description": "Net Income", "rank": "100000", "abbreviation": "" }, "dateReported": "2024-07-22+05:30", "name": "", "OccupationCode": { "symbol": "01", "description": "Salaried", "rank": "100000", "abbreviation": "" }, "partitionSet": "0", "CreditAddress": { "AddressType": "", "StreetAddress": "", "City": "", "PostalCode": "", "Region": "" }, "Source": { "Reference": "0060ae2b-8a43-4276-8c0e-e049d01c3168", "InquiryDate": "2025-11-06+05:30", "Locale": "en_IN", "Bureau": { "symbol": "CIBIL", "description": "", "rank": "100000", "abbreviation": "" } }, "account": "10" }, "Gender": "Male", "CreditStatement": { "StatementType": { "symbol": "DISPUTE", "description": "", "rank": "100000", "abbreviation": "" }, "statement": "", "Source": { "Reference": "0060ae2b-8a43-4276-8c0e-e049d01c3168", "InquiryDate": "2025-11-06+05:30", "Locale": "en_IN", "Bureau": { "symbol": "CIBIL", "description": "", "rank": "100000", "abbreviation": "" } }, "dateUpdated": "" }, "EmailAddress": { "serialNumber": "99114899023", "Email": "05TEST@TRANSUNION.COM" }, "IdentifierPartition": { "Identifier": [ { "ID": { "Id": "##########", "IdentifierName": "SocialId" }, "Source": { "Reference": "0060ae2b-8a43-4276-8c0e-e049d01c3168", "InquiryDate": "2025-11-06+05:30", "Locale": "en_IN", "Bureau": { "symbol": "CIBIL", "description": "", "rank": "100000", "abbreviation": "" } } }, { "ID": { "SerialNumber": "2174734550", "Id": "##########", "IdentifierName": "TaxId" }, "enrichMode": "R", "Source": { "Reference": "", "Locale": "en_US", "Bureau": { "symbol": "", "description": "", "rank": "100000", "abbreviation": "" } } } ] }, "BorrowerName": { "Name": { "Forename": "RAMDAS KADAM" }, "partitionSet": "0", "NameType": { "symbol": "", "description": "", "rank": "100000", "abbreviation": "" }, "Source": { "Reference": "0060ae2b-8a43-4276-8c0e-e049d01c3168", "InquiryDate": "2025-11-06+05:30", "Locale": "en_IN", "Bureau": { "symbol": "CIBIL", "description": "", "rank": "100000", "abbreviation": "" } } }, "BorrowerTelephone": [ { "partitionSet": "0", "PhoneNumber": { "SerialNumber": "59958531684", "Number": "8688358501" }, "enrichMode": "R", "Source": { "Reference": "0060ae2b-8a43-4276-8c0e-e049d01c3168", "InquiryDate": "2025-11-06+05:30", "Locale": "en_IN", "Bureau": { "symbol": "CIBIL", "description": "", "rank": "100000", "abbreviation": "" } }, "PhoneType": { "symbol": "01", "description": "", "rank": "100000", "abbreviation": "" } }, { "partitionSet": "1", "PhoneNumber": { "SerialNumber": "59958574107", "Number": "7222955992" }, "enrichMode": "R", "Source": { "Reference": "0060ae2b-8a43-4276-8c0e-e049d01c3168", "InquiryDate": "2025-11-06+05:30", "Locale": "en_IN", "Bureau": { "symbol": "CIBIL", "description": "", "rank": "100000", "abbreviation": "" } }, "PhoneType": { "symbol": "01", "description": "", "rank": "100000", "abbreviation": "" } }, { "partitionSet": "2", "PhoneNumber": { "SerialNumber": "59958563622", "Number": "9589770122" }, "enrichMode": "R", "Source": { "Reference": "0060ae2b-8a43-4276-8c0e-e049d01c3168", "InquiryDate": "2025-11-06+05:30", "Locale": "en_IN", "Bureau": { "symbol": "CIBIL", "description": "", "rank": "100000", "abbreviation": "" } }, "PhoneType": { "symbol": "01", "description": "", "rank": "100000", "abbreviation": "" } }, { "partitionSet": "3", "PhoneNumber": { "SerialNumber": "59958563556", "Number": "7710919061" }, "enrichMode": "R", "Source": { "Reference": "0060ae2b-8a43-4276-8c0e-e049d01c3168", "InquiryDate": "2025-11-06+05:30", "Locale": "en_IN", "Bureau": { "symbol": "CIBIL", "description": "", "rank": "100000", "abbreviation": "" } }, "PhoneType": { "symbol": "01", "description": "", "rank": "100000", "abbreviation": "" } } ] }, "SafetyCheckPassed": true, "Frozen": "", "Message": { "Code": { "symbol": "", "description": "", "rank": "100000", "abbreviation": "" }, "text": "", "Type": { "symbol": "", "description": "", "rank": "100000", "abbreviation": "" } }, "Sources": { "Source": { "InquiryDate": "2025-11-06T15:05:14.000+05:30", "Bureau": { "symbol": "CIBIL", "description": "", "rank": "100000", "abbreviation": "" }, "OriginalData": "" } }, "DeceasedIndicator": false, "FraudIndicator": false, "TradeLinePartition": { "accountTypeAbbreviation": "", "accountTypeDescription": "", "accountTypeSymbol": "10", "Tradeline": { "DisputeFlag": { "symbol": "", "description": "", "rank": "100000", "abbreviation": "" }, "creditorName": "ICICI BANK LICENCECANCELLED", "branch": "", "highBalance": "900000", "dateOpened": "2022-12-01+05:30", "dateReported": "2024-07-22+05:30", "accountsSoldTo": "", "bureau": "", "writtenOffAmtTotal": "-1", "PayStatus": { "symbol": "", "description": "", "rank": "100000", "abbreviation": "" }, "currentBalance": "0", "subscriberCode": "3090001", "AccountDesignator": { "symbol": "1", "description": "", "rank": "100000", "abbreviation": "" }, "dateAccountStatus": "2024-07-07+05:30", "accountNumber": "##########X401", "AccountCondition": { "symbol": "13", "description": "", "rank": "100000", "abbreviation": "creditFacilityStatus" }, "Source": { "Reference": "7NjPyeyq5kjItZYqsphfDO9LkAEiqkvPbtxYSdgRUi+W9b/PLzWop5oSJzLwfxba6ZDYqHnZyOL9juwmw0TT1A==", "InquiryDate": "2025-11-06+05:30", "Locale": "en_IN", "Bureau": { "symbol": "CIBIL", "description": "", "rank": "100000", "abbreviation": "" } }, "IndustryCode": { "symbol": "", "description": "", "rank": "100000", "abbreviation": "" }, "thirdPartyName": "", "GrantedTrade": { "interestRate": "-1.00", "PaymentFrequency": { "symbol": "03", "description": "", "rank": "100000", "abbreviation": "" }, "serialNumber": "99947270698", "PayStatusHistory": { "endDate": "2024-07-01+05:30", "startDate": "2024-07-01+05:30", "MonthlyPayStatus": { "date": "2024-07-01+05:30", "status": "0" }, "status": "0," }, "EMIAmount": "-1", "WorstPayStatus": { "symbol": "", "description": "", "rank": "100000", "abbreviation": "" }, "CashLimit": "90000", "dateLastPayment": "2024-07-07+05:30", "AccountType": { "symbol": "10", "description": "", "rank": "100000", "abbreviation": "" }, "CreditType": { "symbol": "10", "description": "", "rank": "100000", "abbreviation": "" }, "actualPaymentAmount": "-1", "termMonths": "-1", "CreditLimit": "-1", "CollateralType": { "symbol": "00", "description": "", "rank": "100000", "abbreviation": "" }, "amountPastDue": "0", "collateral": "-1", "TermType": { "symbol": "", "description": "", "rank": "100000", "abbreviation": "" } }, "VerificationIndicator": { "symbol": "", "description": "", "rank": "100000", "abbreviation": "" }, "noOfParticipants": "", "OpenClosed": { "symbol": "", "description": "", "rank": "100000", "abbreviation": "" }, "position": "0", "settlementAmount": "-1", "writtenOffPrincipal": "-1" } } } }, "userConsent": { "consentObject": "", "timestamp": 1769243504244 }, "message": "Success", "statusCode": 0 } ``` 404 callback data ```json { "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 } ``` :::