Output Fields
Field | Description | Data Type | Data Size |
---|---|---|---|
customer_request_id | Displays the customer supplied unique identifier for the request | string | variable based on input |
request_id | Displays a unique Point Predictive supplied identifier for the request | string | 36B |
request_confirm | Confirmation whether or not BorrowerCheck request successfully processed. "Success" confirms request processed "Fail" indicates request not processed and no data returned | string | (4 - 7)B |
request_date | Displays the date the request was run | int (YYYYMMDD) | 8B |
no_warnings | Displays the number of warnings that resulted from the request | int | 4B |
identity_risk | Displays the total number of identity risk warnings for the borrower | int | 4B |
employer_risk | Displays the total number of employer risk warnings for the borrower. A zero indicates not check in API response. | int | (1 - 4)B |
income_risk | Displays the total number of income risk warnings for the borrower A zero indicates not check in API response. | int | (1 - 4)B |
name_validation | Displays whether the name entered for the borrower was validated (see Detailed Output Description for values) | int | 4B |
ssn_validation | Displays whether the Social Security Number for the borrower was valid (see Detailed Output Description for values) | int | 4B |
address_validation | Displays whether the address entered for the borrower was valid (see Detailed Output Description for values) | int | 4B |
dob_validation | Displays whether the date of birth was entered for the borrower was valid (see Detailed Output Description for values) | int | 4B |
employer_validation | Displays whether the employer entered for the borrower was valid (see Detailed Output Description for values) | int | 4B |
income_validation | Displays whether the income entered was valid (see Detailed Output Description for values) | int | 4B |
otp_val_confirm | Code that indicates the degree to which Input Phone was verified for OTP using a 60 Day on file tenure public records search | int | 4B |
ofac_check | Displays whether the name entered for the borrower was found on the US Treasury SDN list or the Consolidated non-SDN List (see Detailed Output Description for values) | int | 4B |
pdf_link | URL link to the PDF containing all the output data | string | variable generated ~80B |
borrowercheck_score | BorrowerCheck score | int || null | (1 - 16)B |
reason_code_1 | Top reason code | string | (0 - 155)B |
reason_code_1_text | Reason code 1 description | string | (0 - 155)B |
reason_code_2 | Second highest reason code | string | (0 - 155)B |
reason_code_2_text | Reason code 2 description | string | (0 - 155)B |
reason_code_3 | Third highest reason code | string | (0 - 155)B |
reason_code_3_text | Reason code 3 description | string | (0 - 155)B |
Sample Output
{
"customer_request_id": "CUSTOMER REQUEST ID",
"request_id": "REQUEST ID",
"request_confirm": "REQUEST STATUS",
"request_date": YYYYMMDD,
"no_warnings": WARNINGS,
"identity_risk": ID_RISK,
"employer_risk": EMP_RISK,
"income_risk": INCOME_RISK,
"name_validation": NAME_VALID,
"ssn_validation": SSN_VALID,
"address_validation": ADDR_VALID,
"dob_validation": DOB_VALID,
"employer_validation": EMP_VALID,
"income_validation": INCOME_VALID,
"opt_val_confirm": OTP_CONFIRM,
"ofac_check": OFAC_CHECK,
"pdf_link": "PDF LINK",
"borrowercheck_score": "BC SCORE",
"reason_code_1": CODE_1,
"reason_code_1_text": "CODE 1 DESCRIPTION",
"reason_code_2": CODE_2,
"reason_code_2_text": "CODE 2 DESCRIPTION",
"reason_code_3": CODE_3,
"reason_code_3_textd": "CODE 3 DESCRIPTION"
}