Sign in

v4

OpenAPI 3.0.12026-07-3189233676.2 KB
Scoring Attributes

Create a scoring attributes report

post/v1/scoring_attributes/reports

Request body

lender_referencestring 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.

customer_identifierstring required

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

purpose'decisioning' | 'verification' | 'analytics' 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.

cutoff_datestring 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.

loan_data_enabledboolean nullable

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.

Example request

{
  "lender_reference": "appl-1234",
  "customer_identifier": "cust-9999",
  "purpose": "decisioning",
  "cutoff_date": "2021-03-31",
  "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-31"
    }
  ],
  "transactions": [
    {
      "identifier": "tran-2222",
      "account_identifier": "acct-4567",
      "post_date": "2021-03-03",
      "amount": -100.03,
      "status": "posted",
      "description": "Local Merchant Purchase"
    }
  ]
}

Response

Successful operation

report_idstring

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