CIBIL Score API

POST  https://XXXXXXXXXXXXXXXX/api/AOP/V1/PanDetails/MobileNumberWise


This API allows a client application to submit a mobile number and registration reference to AOPay and receive CIBIL Score (PAN details) and available customer information.

Body Parameters
{
 "MobileNumber":"XXXXXXXX10",  
 "RegistrationID":"AOP-XXXX-XXXX"  
}
Request Parameters
Name Type Mandatory Description
MobileNumber String Yes Valid Mobile Number.
RegistrationID String Yes Registration ID provided during partner onboarding.
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://XXXXXXXXXXXXXXXX/api/AOP/V1/PanDetails/MobileNumberWise' \
--header 'Content-Type: application/json' \
--data  '{
   "MobileNumber": "XXXXXXXX10",
   "RegistrationID": "AOP-XXXX-XXXX"
}'
                                
import requests
import json

url = 'https://XXXXXXXXXXXXXXXX/api/AOP/V1/PanDetails/MobileNumberWise'
payload = json.dumps({
    "MobileNumber": "XXXXXXXX10",
    "RegistrationID": "AOP-XXXX-XXXX"
}) 

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://XXXXXXXXXXXXXXXX/api/AOP/V1/PanDetails/MobileNumberWise',
  "headers" : {
    "Content-Type" : 'application/json'
  },
  body: JSON.stringify({
    "MobileNumber": "XXXXXXXX10",
    "RegistrationID": "AOP-XXXX-XXXX"
  }) 
}; 
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://XXXXXXXXXXXXXXXX/api/AOP/V1/PanDetails/MobileNumberWise')
var content = new StringContent(
  "{
    "MobileNumber": "XXXXXXXX10",
    "RegistrationID": "AOP-XXXX-XXXX"
  }",
  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://XXXXXXXXXXXXXXXX/api/AOP/V1/PanDetails/MobileNumberWise',
  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 =>  '{
    "MobileNumber": "XXXXXXXX10",
    "RegistrationID": "AOP-XXXX-XXXX"
  }',
  CURLOPT_HTTPHEADER =>  array(
    'Content-Type: application/json'
  ),
));
$response =  curl_exec($curl);
curl_close($curl);
echo $response;
                                

RESPONSE

200

401

412

-Result

Example

{
    "http_response_code": 200,
    "client_ref_num": "XXXX-REF-XXXXX",
    "request_id": "07aeerer-7wer-8568-g2e1-f6783c41f5c8",
    "result_code": 101,
    "message": "success",
    "result": {
        "name": "XXXX CUSTOMER",
        "dob": "01-01-XXXX",
        "age": "36",
        "gender": "MALE",
        "pan": "ABCDE1234F",
        "email": "xxxxcustomer@example.com",
        "official_documents": null,
        "alternate_emails": null,
        "alternate_mobile_numbers": null,
        "address": [
                 {
                   "first_line_of_address": "123 DEMO STREET",
                   "second_line_of_address": "DEMO AREA",
                   "third_line_of_address": "DEMO LOCALITY",
                   "city": "DELHI",
                   "state": "DELHI",
                   "postal_code": "110001",
                   "country_code": "IN",
                   "reported_date": "01-01-XXXX",
                 }
                ],
        "score": "750",
        "additional_details": null
     },
    "Status": "TRUE",
    "Value": ""
}


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

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