Transunion CIBIL Report API

POST  https://apxxxxxxxxxin/api/AOP/V2/Transunion/Score/Hybrid


A Transunion Cibil Report in this context is a data report generated using the customer’s personal and identification details — such as firstname, lastname, phone number, gender, pan number and registration id — to retrieve and analyze their cibil report.

Body Parameters
{
 "FirstName":"test",  
 "LastName":"user",  
 "PhoneNumber":"9911XXXXXX",  
 "Gender":"Male",  
 "PanNumber":"XXXXFG12XXX",  
 "RegistrationID":"AOP-XXX",  
}
Request Parameters
Name Type Mandatory Description
FirstName String Yes User's Firstname
LastName String Yes Users's Lastname
PhoneNumber String Yes User's Phone Number
Gender String Yes User's Gender
PanNumber String Yes User's Pan Number
RegistrationID String Yes User's Registration ID
Responses

200

200

Response

200

RESPONSE BODY

object

Response

401

RESPONSE BODY

returnMessage     string

401

401

412

412

Response

412

RESPONSE BODY

returnMessage     string


Did this page help you?     Yes    No

Language
shell Shell
python Python
node Node
c# C#
php PHP

cURL

curl --location 'https://apxxxxxxxxxin/api/AOP/V2/Transunion/Score/Hybrid' \
--header 'Content-Type: application/json' \
--data  '{
   "FirstName": "Test",
   "LastName": "User",
   "PhoneNumber": "9911XXXXXX",
   "Gender": "Male",
   "PanNumber": "XXXXFG12XXX",
   "RegistrationID": "AOP-XXX"
}'
                                
import requests
import json

url = 'https://apxxxxxxxxxin/api/AOP/V2/Transunion/Score/Hybrid'
payload = json.dumps({
   "FirstName": "Test",
   "LastName": "User",
   "PhoneNumber": "9911XXXXXX",
   "Gender": "Male",
   "PanNumber": "XXXXFG12XXX",
   "RegistrationID": "AOP-XXX"
}) 

headers = {
  "Content-type" : "application/json"
}

response = requests.request("POST", url, headers=headers, data=payload)

print (response.text)
                                
var requests = require("request");
var options = { 
  "method" : "POST",
  "url" : 'https://apxxxxxxxxxin/api/AOP/V2/Transunion/Score/Hybrid',
  "headers" : {
    "Content-Type" : 'application/json'
  },
  body: JSON.stringify({
   "FirstName": "Test",
   "LastName": "User",
   "PhoneNumber": "9911XXXXXX",
   "Gender": "Male",
   "PanNumber": "XXXXFG12XXX",
   "RegistrationID": "AOP-XXX"
  }) 
}; 
request(options, function(error, response){
   if(error) throw new Error(error);
   console.log(response.body); 
}); 
                                
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post,'https://apxxxxxxxxxin/api/AOP/V2/Transunion/Score/Hybrid')
var content = new StringContent(
  "{
   "FirstName": "Test",
   "LastName": "User",
   "PhoneNumber": "9911XXXXXX",
   "Gender": "Male",
   "PanNumber": "XXXXFG12XXX",
   "RegistrationID": "AOP-XXX"
  }",
  null,"application/json"
); 

request.Content = content;
var response =  await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
                                
<?php
$curl =  curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL =>  'https://apxxxxxxxxxin/api/AOP/V2/Transunion/Score/Hybrid',
  CURLOPT_RETURNTRANSFER =>  true,
  CURLOPT_ENCODING =>  '',
  CURLOPT_MAXREDIRS =>  "10",
  CURLOPT_TIMEOUT =>  0,
  CURLOPT_FOLLOWLOCATION =>  true,
  CURLOPT_HTTP_VERSION =>  CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST =>  'POST',
  CURLOPT_POSTFIELDS =>  '{
   "FirstName": "Test",
   "LastName": "User",
   "PhoneNumber": "9911XXXXXX",
   "Gender": "Male",
   "PanNumber": "XXXXFG12XXX",
   "RegistrationID": "AOP-XXX"
  }',
  CURLOPT_HTTPHEADER =>  array(
    'Content-Type: application/json'
  ),
));
$response =  curl_exec($curl);
curl_close($curl);
echo $response;
                                

SAMPLE RESPONSE

200

401

412

-Result

Example

{
    "status": {
        "code": 200,
        "type": "success",
        "message": "CIBIL report ready."
        },
    "message": "CIBIL report ready",
    "data": {
        "status": "success",
        "web_token_url": "htXXXXXXXXXJSv4mGPlfibTOTBUgH2kwlRVdUWZ1I",
        "client_key": "tu_bXXXXXXXa9758",
        "steps_summary": [
            {
            "step": 1,
            "name": "FulfillOffer",
            "status": "success"
            },
            {
            "step": 2,
            "name": "GetAuthenticationQuestions",
            "status": "success"
            },
            {
            "step": 3,
            "name": "GetCustomerAssets",
            "status": "success"
            }, 
            {
            "step": 4,
            "name": "GetProductWebToken",
            "status": "success"
            }                                         
        ],
        "steps": [
            {
            "step": 1,
            "name": "FulfillOffer",
            "status": "success",
            "http_code": 200,
            "response": {
                "FulfillOfferResponse":{
                 "ResponseStatus": "Success",
                 "ResponseKey": "e9fXXXXXX70877:-4302a953:19fa73705f7:-1f21",
                 "FulfillOfferSuccess": {
                      "Status": "InProgress",
                   }
                }
              }
            }
       ]
    }
}


 
 
{
    "returnMessage": "Unauthorized access. Please log in again."
}
                                
 
{
   "returnMessage": "Invalid registration ID"
}

                                
 
{
   "returnMessage": "Precondition failed. Please try again."
}