endpoint glossary and endpoint explanation
Authentication
/auth
enter login credentials (username / password) for authentication tokens
/auth/challenge
for multi-factor login challenge - requires mobile number for SMS code delivery
Core Functions
/api/borrower-check
used to submit BorrowerCheck applications (dealer / lender)
/api/request_notes
fetch notes attached to a given application
/api/request_notes (POST)
append note to a given application
/api/borrower-check-out-wallet-questions
generate out of wallet questions for a given application
/api/borrower-check-out-wallet-check
validate generated out of wallet questions for a given application (per attempt / session)
/api/borrower-check-indicator
toggle the manually verification status of a given application
/api/borrower-check-information
fetch dealership / rooftop application information
/api/dealership-of-user
fetch all dealerships / rooftops under a given lender
/api/request-data
fetch applications of a given dealership / rooftop & lender combo - filtered and server-side paginated
OTP
/api/send_otp
send One Time Passcode to a given mobile phone number for verification purposes
/api/verify_otp
verify One Time Passcode of a given session / client id / phone number
MLA
/api/verify_mla
verify Military Lending Act veteran status (requires application / app_id)
Intellicheck
/api/intellicheck
request intellicheck verification of drivers license
/api/intellicheck_result
request results of intellicheck verification
Embedded Widgets
/bc_widget
generate widget for BorrowerCheck information about borrower / employer