BankVERIFY+ can be performed from one simple API call
Get an OAuth token
You must log into https://test.RIBBIT.ai to obtain your
clientId
and clientSecret
You can obtain a bearer token from POST /v3/Token For more information on obtaining a token, click here
Build your request
BankVERIFY+ requires specific PII (personally-identifiable information) in order to run properly and provide the most accurate results
See example for
Customer PII Data
customerId
The customer id (or other unique id) from your system that references this customer or applicant
The customer id (or other unique id) from your system that references this customer or applicant
requestTypeId
A requestTypeId of 1 indicates that this verification is being ran on an individual, where 2 is for a small/medium business
A requestTypeId of 1 indicates that this verification is being ran on an individual, where 2 is for a small/medium business
signerFirstName
The first name of the customer or signer on the application
The first name of the customer or signer on the application
signerLastName
The last name of the customer or signer on the application
The last name of the customer or signer on the application
signerPhone
10-digit phone number of the customer or signer on the application
10-digit phone number of the customer or signer on the application
signerEmail
E-mail address of the customer or signer on the application
E-mail address of the customer or signer on the application
signerAddress
The physical address of the customer or signer on the application. If you have a physical and PO address, use the physical address.
The physical address of the customer or signer on the application. If you have a physical and PO address, use the physical address.
Account Information
routingNumber
The 9-digit routing number of the customer's bank.
For testing purposes, you must use a real routing number
The 9-digit routing number of the customer's bank.
For testing purposes, you must use a real routing number
accountNumber
The customer's account number, including any leading zero's, when available.
For testing, you must use realistic numbers or test numbers
Click here for a list of test account numbers
The customer's account number, including any leading zero's, when available.
For testing, you must use realistic numbers or test numbers
Click here for a list of test account numbers
accountTypeId
"1" for checking account, "2" for savings account
Please submit "1" or "2" as a string.
"1" for checking account, "2" for savings account
Please submit "1" or "2" as a string.
accountToken
A pre-existing account token that references an account already saved in the RIBBIT platform
A pre-existing account token that references an account already saved in the RIBBIT platform
Loan / Offer / Spending Velocity Details
This information is used to determine affordability of a payment. Many of our attributes and results are centered around the customer's ability to pay (or repay) a specific amount.
offerAmount
The total amount of the loan, the offer amount for a credit product, or the maximum amount of spending allowed. If you do not have a total amount at this time, use an estimate or average. When being used at the top of an underwriting waterfall, the median amount is recommended.
The total amount of the loan, the offer amount for a credit product, or the maximum amount of spending allowed. If you do not have a total amount at this time, use an estimate or average. When being used at the top of an underwriting waterfall, the median amount is recommended.
paymentAmount
The amount of each payment, or the median payment/spending amount
The amount of each payment, or the median payment/spending amount
terms
The terms of the repayment schedule. Available options are daily_oblig, weekly_oblig, biweekly_oblig, or monthly_oblig
The terms of the repayment schedule. Available options are daily_oblig, weekly_oblig, biweekly_oblig, or monthly_oblig
Call BankVERIFY+
POST /v3/riskservices/onboarding/accounts/requestbvpanalytics
{ "applicationInformation": { "requestTypeId": 1, "customerId": "A72F817B-744F-4D1F-B347-71E026D0B181", "signerFirstName": "John", "signerMiddleName": null, "signerLastName": "Smith", "signerPhone": "4565865555", "signerEmail": "jsmith@noemail.com", "signerAddress": { "address": "678 Fake Street", "city": "Oxford", "state": "OH", "zip": "45056" }, "coSignerFirstName": null, "coSignerMiddleName": null, "coSignerLastName": null, "accountToken": null, "routingNumber": "642260020", "accountNumber": "111111111", "accountTypeId": "1", "offerAmount": 2000, "terms": "weekly_oblig", "paymentAmount": 200, "acquisitionOrRefreshType": "Acquisition" } }