Sample Response

Sample Success Response :

JSON

{
    "is_success": true,
    "data": {
        "credit_report_uuid":"<credit report uuid>",
        "status":"<report_generated,report_not_generated>",
        "score":"<indicative score of the customer, only if it is generated and enabled>"
    }
}

Sample Failure Response :

JSON

{
    "is_success": false,
    "error": {
        "message": "<message explaining the error>",
        "code": "report_pull_failed" 
    }
}

The API returns a unique credit report id, which can be used to run policy in Run Policy API.