--- title: Credit Analytics - Consent Flow Decrypt Data slug: api-marketplace/credit-analytics-consent-flow-decrypt-data createdAt: 2023-12-08T06:16:39.746Z --- ### Introduction This API is for giving demo only on our api specs portal for Credit Analytics - 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 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 reports to the user's provided callback URL. ## Sample Curl: :::CodeblockTabs preproduction ```curl curl --location 'https://api-preproduction.signzy.app/api/v3/test-decrypt-data' \ --header 'Authorization: ' \ --header 'Content-Type: application/json' \ --data '{"requestData": ""}' ``` Production ```curl curl --location 'https://api.signzy.app/api/v3/test-decrypt-data' \ --header 'Authorization: ' \ --header 'Content-Type: application/json' \ --data '{"requestData": ""}' ``` ::: ## Input Parameters: | Parameter | Type | Mandatory/Optional | Description | | ----------- | ------ | ------------------ | ------------------------------------------ | | requestData | String | Mandatory | Encrypted string from Bureau consent flow. | ### Sample Status Codes And Messages :::CodeblockTabs 200 OK ```json { "result": { "referenceId": "32d303ee-4d07-4a55-b0d6-b06f54b15c5b", "url": "", "requestId": "449c6147-7191-4a65-81dc-e28faf7e1228", "smsStatus": "OTP Bypass Enabled", "emailStatus": "OTP Bypass Enabled" } } ``` 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 } } ``` ::: ### CIBIL- Sample Response :::CodeblockTabs 200 response ```json { "statusCode": 200, "message": "SUCCESS", "data": { "CIBILReport": { "controlData": { "success": true }, "consumerCreditData": [ { "tuefHeader": { "headerType": "TUEF", "version": "12", "memberRefNo": "1775732335424", "enquiryMemberUserId": "SU00149999_UATC2CNPE", "subjectReturnCode": 0, "enquiryControlNumber": "002162210355", "dateProcessed": "09042026", "timeProcessed": "162855" }, "names": [ { "index": "N01", "name": "RAHUL KUMAR SHARMA", "birthDate": "15051990", "gender": "2" } ], "ids": [ { "index": "I01", "idType": "01", "idNumber": "ABCPS1234Q", "enquiryEnriched": "Y" } ], "scores": [ { "scoreName": "CIBILTUSC3", "scoreCardName": "16", "scoreCardVersion": "10", "scoreDate": "09042026", "score": "00147" } ], "addresses": [ { "index": "A01", "line1": "42, LINKING ROAD, BANDRA WEST, MUMBAI,", "line2": "MAHARASHTRA, MUMBAI, MAHARASHTRA, 400001", "stateCode": "27", "pinCode": "400001", "addressCategory": "04", "residenceCode": "01", "dateReported": "09042026", "enquiryEnriched": "Y" } ] } ] }, "CIBILPDF": "https://preproduction-persist.signzy.tech/api/files/46292430/download/79643a927f0b44d0a3be064745a629b91d61c944bf854394a4e6ae5f42ee47cd.pdf" } } ``` ::: ### CIBIL- Output Parameters | Parameter | Type | Description | | ------------------------------------ | ------------ | ------------------------------------------------------------------------------------------- | | statusCode | Integer | HTTP status code of the API response indicating request success or failure (200 = success). | | message | String | High-level status message returned by the API. | | data | Object | Wrapper object containing the actual response payload. | | data.CIBILReport | Object | Contains structured credit report data from CIBIL. | | data.CIBILReport.controlData | Object | Metadata about report processing status. | | data.CIBILReport.controlData.success | Boolean | Indicates whether the credit report was successfully fetched. | | data.CIBILReport.consumerCreditData | Array | List of consumer credit report records (typically one per enquiry). | | consumerCreditData\[].tuefHeader | Object | Header section containing enquiry and processing metadata. | | tuefHeader.headerType | String | Type of header, usually “TUEF” (TransUnion Extract Format). | | tuefHeader.version | String | Version of the TUEF format used. | | tuefHeader.memberRefNo | String | Unique reference number assigned by the requesting member. | | tuefHeader.enquiryMemberUserId | String | User ID of the member initiating the enquiry. | | tuefHeader.subjectReturnCode | Integer | Code indicating match result (0 = successful match). | | tuefHeader.enquiryControlNumber | String | Unique control number for the enquiry. | | tuefHeader.dateProcessed | String | Date when the request was processed (DDMMYYYY). | | tuefHeader.timeProcessed | String | Time when the request was processed (HHMMSS). | | consumerCreditData\[].names | Array | List of consumer identity details. | | names\[].index | String | Identifier for the name record. | | names\[].name | String | Full name of the consumer. | | names\[].birthDate | String | Date of birth (DDMMYYYY). | | names\[].gender | String | Gender code (e.g., 1 = Male, 2 = Female — depends on bureau mapping). | | consumerCreditData\[].ids | Array | Identification details of the consumer. | | ids\[].index | String | Identifier for the ID record. | | ids\[].idType | String | Type of ID (e.g., 01 = PAN). | | ids\[].idNumber | String | ID number (e.g., PAN). | | ids\[].enquiryEnriched | String | Indicates whether ID data was enriched during enquiry (Y/N). | | consumerCreditData\[].scores | Array | Credit score details of the consumer. | | scores\[].scoreName | String | Name of the score model used (e.g., CIBILTUSC3). | | scores\[].scoreCardName | String | Scorecard identifier used by bureau. | | scores\[].scoreCardVersion | String | Version of the scorecard. | | scores\[].scoreDate | String | Date when the score was generated (DDMMYYYY). | | scores\[].score | String | Credit score value (e.g., 00147). | | consumerCreditData\[].addresses | Array | Consumer address details. | | addresses\[].index | String | Identifier for the address record. | | addresses\[].line1 | String | Primary address line. | | addresses\[].line2 | String | Secondary address details including city/state/pincode. | | addresses\[].stateCode | String | State code as per bureau classification. | | addresses\[].pinCode | String | Postal PIN code. | | addresses\[].addressCategory | String | Address type (e.g., residential, office — bureau-specific codes). | | addresses\[].residenceCode | String | Residence type (owned/rented/etc., bureau-specific). | | addresses\[].dateReported | String | Date when address was reported (DDMMYYYY). | | addresses\[].enquiryEnriched | String | Indicates if address was enriched (Y/N). | | data.CIBILPDF | String (URL) | Download link for the full CIBIL credit report in PDF format. |