API Reference

Sample Response

Sample Success Response :

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

Sample Failure Response :

{
    "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.