Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| appSource |
The source where the app request is submitted. |
string |
Required |
Body Parameters
The credit report query.
CreditReportQuery| Name | Description | Type | Additional information |
|---|---|---|---|
| appId |
Gets or sets the application identifier. |
integer |
None. |
| fileNumber |
Gets or sets the file number. |
string |
None. |
| includeExperian |
Gets or sets a value indicating whether we are requesting from Experian. |
boolean |
None. |
| includeEquifax |
Gets or sets a value indicating whether we are requesting from Equifax. |
boolean |
None. |
| includeTransunion |
Gets or sets a value indicating whether we are requesting from Transunion. |
boolean |
None. |
| orderType |
Gets or sets the type of the order. |
CreditServices.OrderType |
Required |
| pullType |
Gets or sets the type of the order. |
PullType |
None. |
| personIds |
Gets or sets the person identifiers. |
Collection of integer |
Required |
| provider |
Gets or sets the provider. |
string |
None. |
Request Formats
application/json, text/json
Sample:
{
"appId": 1,
"fileNumber": "sample String 2",
"includeExperian": true,
"includeEquifax": true,
"includeTransunion": true,
"orderType": 0,
"pullType": 0,
"personIds": [
1,
2
],
"provider": "sample String 3"
}
text/html
Sample:
{"appId":1,"fileNumber":"sample String 2","includeExperian":true,"includeEquifax":true,"includeTransunion":true,"orderType":0,"pullType":0,"personIds":[1,2],"provider":"sample String 3"}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The result of the action.
RPCResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| data |
Gets or sets the data. |
Object |
None. |
| errors |
Gets or sets the errors. |
Collection of RPCError2 |
None. |
| included |
Gets or sets the included. |
Collection of Object |
None. |
| messages |
Gets or sets the errors. |
Collection of string |
None. |
| modelId |
Gets or sets the model identifier. |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"data": {},
"errors": [
{
"code": "DataValidation",
"detail": "sample String 1",
"id": "sample String 2",
"status": 100,
"title": "sample String 3"
},
{
"code": "DataValidation",
"detail": "sample String 1",
"id": "sample String 2",
"status": 100,
"title": "sample String 3"
}
],
"included": [
{},
{}
],
"messages": [
"sample String 1",
"sample String 2"
],
"modelId": 1
}
text/html
Sample:
{"data":{},"errors":[{"code":"DataValidation","detail":"sample String 1","id":"sample String 2","status":100,"title":"sample String 3"},{"code":"DataValidation","detail":"sample String 1","id":"sample String 2","status":100,"title":"sample String 3"}],"included":[{},{}],"messages":["sample String 1","sample String 2"],"modelId":1}