Skip to main content
POST
/
api
/
templates
/
consumer_credit_health_snapshot
/
furnish
Furnish data for Consumer Credit Health Snapshot
curl --request POST \
  --url https://api.example.com/api/templates/consumer_credit_health_snapshot/furnish \
  --header 'Content-Type: application/json' \
  --data '
{
  "date_of_birth": "2023-11-07T05:31:56Z",
  "first_name": "<string>",
  "last_name": "<string>",
  "personal_address_city": "<string>",
  "personal_address_line_1": "<string>",
  "personal_address_state": "<string>",
  "personal_address_zip": 123,
  "phone_number": 123,
  "social_security_number": 123,
  "consumer_cross_reference_id": "<string>",
  "aggregated_credit_accounts_total_outstanding_consumer_debt": 123,
  "aggregated_credit_accounts_worst_current_delinquency_status": 123,
  "bank_inflow_inferred_annual_income": 123,
  "cashflow_based_credit_score_factors_json": 123,
  "cashflow_based_credit_score_name": 123,
  "cashflow_based_credit_score_value": 123,
  "cashflow_based_credit_score_version": 123,
  "credit_based_credit_score_factors_json": "<string>",
  "credit_based_credit_score_name": 123,
  "credit_based_credit_score_value": 123,
  "credit_based_credit_score_version": "<string>",
  "credit_based_modeled_income": 123,
  "debt_to_income_ratio": 123,
  "entity_stated_annual_income": 123,
  "pay_frequency": "<string>",
  "paystub_upload": "<string>",
  "personal_address_line_2": "<string>",
  "personal_email": "<string>",
  "tax_return_upload": "<string>"
}
'
{
  "success": true
}

Body

application/json

Input model for /templates/consumer_credit_health_snapshot/furnish

Furnish data for Consumer Credit Health Snapshot

date_of_birth
string<date-time>
required
first_name
string
required
last_name
string
required
personal_address_city
string
required
personal_address_line_1
string
required
personal_address_state
string
required
personal_address_zip
integer
required
phone_number
integer
required
social_security_number
integer
required
consumer_cross_reference_id
string | null
aggregated_credit_accounts_total_outstanding_consumer_debt
aggregated_credit_accounts_worst_current_delinquency_status
bank_inflow_inferred_annual_income
cashflow_based_credit_score_factors_json
cashflow_based_credit_score_name
cashflow_based_credit_score_value
cashflow_based_credit_score_version
credit_based_credit_score_factors_json
string | null
credit_based_credit_score_name
credit_based_credit_score_value
credit_based_credit_score_version
string | null
credit_based_modeled_income
debt_to_income_ratio
entity_stated_annual_income
pay_frequency
string | null
paystub_upload
string | null
personal_address_line_2
string | null
personal_email
string | null
tax_return_upload
string | null

Response

Successful Response

Output model for /templates/consumer_credit_health_snapshot/furnish

Furnish data for Consumer Credit Health Snapshot

success
boolean
default:true