Skip to main content
POST
/
v1
/
scoring_attributes
/
reports
Create a scoring attributes report
curl --request POST \
  --url https://prod.truv.com/v1/scoring_attributes/reports \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>' \
  --data '
{
  "lender_reference": "appl-1234",
  "customer_identifier": "cust-9999",
  "purpose": "decisioning",
  "cutoff_date": "2021-03-31T00:00:00.000Z",
  "institutions": [
    {
      "identifier": "inst-9999",
      "name": "Bank of America",
      "data_source": "aggregation"
    }
  ],
  "accounts": [
    {
      "identifier": "acct-4567",
      "institution_identifier": "inst-9999",
      "type": "checking",
      "balance_amount": 35.22,
      "balance_date": "2021-03-31T00:00:00.000Z",
      "autopay": true
    }
  ],
  "transactions": [
    {
      "identifier": "tran-2222",
      "account_identifier": "acct-4567",
      "post_date": "2021-03-03T00:00:00.000Z",
      "amount": -100.03,
      "status": "posted",
      "description": "Local Merchant Purchase"
    }
  ],
  "loan_data_enabled": true
}
'
{
  "report_id": "<string>"
}

Authorizations

​
X-Access-Client-Id
string
header
required

Client ID

​
X-Access-Secret
string
header
required

Client Access Key

Body

application/json
​
lender_reference
string
required

This is the value that can be used by the lender to identify the report request. For example, this could be the loan application number.

Example:

"appl-1234"

​
customer_identifier
string
required

This is a customer level unique identifier. This key should not use personally identifiable information such as SSN or government ID numbers.

Example:

"cust-9999"

​
purpose
enum<string>
required

This field indicates the purpose of the report. Valid values are: ‘decisioning’ for FCRA credit decisioning, ‘verification’ for non-FCRA underwriting verifications and ‘analytics’ for retroactive reports used solely for analytical purposes.

Available options:
decisioning,
verification,
analytics
Example:

"decisioning"

​
cutoff_date
string
required

The latest date of financial activity that will be included in the report. In most cases, this should be set to the current date or application date. In the case of retro-scored reports, this date will be a date in the past.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2021-03-31T00:00:00.000Z"

​
institutions
object[]
required
​
accounts
object[]
required
​
transactions
object[]
required
​
loan_data_enabled
boolean | null

This field indicates whether the lender wants to include any supplied credit card and loan data in the calculation of metrics. Value defaults to false if field is not specified.

Response

Successful operation

​
report_id
string

This is a unique report_id generated by the scoring attributes API to identify a report.