Pulling a Credit Report
Description
This web service pulls credit reports for contact or borrower of an application. The application number has to be specified in the URL.
Definition
GET https://<domain>/services/apexrest/peer/v1/applications/pullCreditReport/<appplicationID>
Parameters
The following table provides details of the request parameter used by this web service:
| Field | Type | Description |
|---|---|---|
applicationIId |
Decimal |
|
Error Messages
When you use this web service you can receive the possible error messages as shown in the following table:
| Error Code | Error Message | System.Label | Reason | HTTP Status Code |
|---|---|---|---|---|
INVALID_INPUT |
Application ID is null | APPLICATION_ID_NULL |
You will receive this error if the Application ID is not specified in the Request Parameters. |
400 |
INVALID_INPUT |
Unable to find the application | APPLICATION_NOT_FOUND |
You will receive this error if there is no record found with the Application ID. |
400 |
| UNAUTHORIZED | Insufficient access | NA | You will receive this error if you have insufficient access to call the API. | 401 |
API_EXCEPTION |
<exception_message> | NA |
You will receive this error if any validation fails or any unexpected error occurs during the processing of the request, the system will raise the exception. |
500 |
Sample Request
The sample request to be sent is as shown below:
GET https://<domain>/services/apexrest/genesis/v1/applications/pullCreditReport/<appplicationID>
Sample Response
This sample response contains the credit report for the given borrower. The sample response that you will receive is as shown below:
{
"status": "SUCCESS",
"response": [],
"errorMessage": null,
"errorCode": "NO_ERROR",
"content": [
{
"attributes": {
"type": "ints__Credit_Report__c",
"url": "/services/data/v32.0/sobjects/ints__Credit_Report__c/a2gF0000000A7UxIAK"
},
"Name": "CR-0000002926",
"ints__Credit_Report_Attachment__c": "https://na10.salesforce.com/00PF000000Latl3MAB",
"ints__CreditReportScore__r": {
"totalSize": 1,
"done": true,
"records": [
{
"attributes": {
"type": "ints__Credit_Report_Score__c",
"url": "/services/data/v32.0/sobjects/ints__Credit_Report_Score__c/ a2fF000000092IJIAY"
},
"Name": "CRS-0000000255",
"ints__CreditFileID__c": "CreditFile1",
"ints__CreditScoreID__c": "CreditScore15",
"ints__Date__c": "2015-02-14",
"Id": "a2fF000000092IJIAY",
"ints__Value__c": "668",
"ints__CreditReport__c": "a2gF0000000A7UxIAK",
"ints__BorrowerID__c": "Borrower",
"genesis__Score__c": 668
}
]
},
"ints__CreditRatingCodeType__c": "Experian",
"ints__CreditReportType__c": "Merge",
"Id": "a2gF0000000A7UxIAK",
"ints__CreditBureauName__c": "MCL DEMO",
"ints__CreditReportIdentifier__c": "126273"
}
]
}