Credit Score - Introduction
You will need to login before initiating Credit Score request. You are required to pass the access token received from the login call, as authorization header in the request for Credit Score API along with other parameters.
1. API Flow
The Credit Score API has 4 endpoints as described below:
- Initiate Request
- Authenticate Request
- Get Report Request
- Get Data Request
Before Getting the Report the user has to complete the Initiate, Authenticate Requests (Stages) in the order provided.
The below section describes each of the endpoint individually:
1.1 Initiate Request
- The Initiate Request or Initiation Stage is where the client first initiate the request for getting a credit score report.
- The request requires personal details of the individual whose credit score (report) is to be fetched.
- The request generates ReportId and OrderId which is required for further stages.
- You can check the docs for the initiation stage
1.2 Authenticate Request
- The Authenticate Request (Endpoint) or Authentication Stage is where the client authenticate (by completing QnA/in some cases QnA is not required).
- The request requires ReportId and OrderId from the initiation Stage
- 1.2.1 Auto Authentication
- In some cases the individual doesn't have to complete the QnA, in case the report has been generated in the past. (This is termed as "Auto Authentication")
- In case, of Auto-Authentication the individual can directly move to Get Report Request or Get Report Stage and fetch the credit score report.
- 1.2.2 Questionnaire (Not Auto Authenticated)
- You can check the docs for the authentication stage
- In case, the user has to complete QnA. The individual is presented with Multiple Choice Style Questions.
- The user only has to answer one question correctly, to authenticate successfully.
- The individual has to choose one options from the Muliple Choices.
- In case the answer is wrong, another questions with muliple choices is returned
- Only three questions will be asked, in case the user is unable to answer all three of them correctly. The Authentication Stage Fails.
- In case, of authentication failure the user can start from authentication stage. For more details, refer the docs for Authentication Stage.
1.3 Get Report Request
- The Get Report Request (Endpoint) or Get Report Stage is where the user can fetch the report.
- This endpoint can only be hit after completing the above stages successfully.
- The report generated is in XML format.
- You can check the docs for the get report stage
1.4 Get Data Request
- This endpoint can be hit anytime after the initiation stage. To get the information regarding the request.
- The request returns the information of the individual along with information regarding the stage at which the user is.
- The request requires the reportId and orderId generated in initiation stage and details can only be fetched by the Patron which initiated the request.
- You can check the docs for the get data endpoint
2. Status Code
This Sections describes all the various status code returned by the endpoints:
STATUS CODE | DESCRIPTION |
|---|---|
S00 | Transaction Error In Inquiry |
S01 | Authentication Successful |
S02 | Authentication Failed |
S03 | Client Cancelled the Transaction |
S04 | Authorization for the report ID: not complete |
S05 | Validation Failure |
S06 | Request Accepted |
S07 | Validation Failed for Request Format |
S08 | Technical Error |
S09 | No Record Found |
S10 | Auto Authenticated! Client can Proceed to Stage-3 |
S11 | Client will need to complete Questionnaire Phase |