Checkbook.io API

Checkbook.io API Docs

Welcome to Checkbook's API! Just like our product, our API is simple to use and understand.

You'll find comprehensive guides and documentation to help you start working with Checkbook as quickly as possible, as well as support if you get stuck. Let's jump right in!

Guides    API Reference

Instant Account Verification

Profile type

If you haven't added a bank account yet, you will first need to select your profile type, which can be either Individual or Business. To get started, click on the Please complete your profile by adding a bank account message.

Method selection

After you select you profile type and enter the required information, you will see this dialog and you'll need to select Instant Verification.

Recipients can verify their bank accounts instantly using their online banking credentials. This information is tokenized using secure bank APIs. At no time are your login credentials stored anywhere in Checkbook’s servers.

Find the bank

Start typing in the name of your bank, then select if from the list once you narrow down the options and then click Submit:

The bank you are looking for may not be in the list. In this case, you can use Manual Verification instead.

Login to the bank

Depending on what bank you select from the list, we will display one of the two following forms for logging in to your bank.

Plaid form

For some banks, we use Plaid as a 3rd party service for connecting to your bank and accessing your bank accounts. You'll see the following disclaimer and you'll need to click Continue:

Next, you need to enter you username and password to log in to your bank:

🚧

Sandbox testing

On Sandbox enter the username user_good and the password pass_good as test credentials to log in to the selected bank. These credentials only work in Sandbox, thus in the Live environment you will need to use your real credentials.

If the login is successful, you'll see the following message and you need to click on Continue. The final step will be to add the bank account by selecting it from the displayed list.

Checkbook form

You simply need to enter you username and password to log in to your bank:

🚧

Sandbox testing

On Sandbox enter the username checkbook_test and the password checkbook_good as test credentials to log in to the selected bank. These credentials only work in Sandbox, thus in the Live environment you will need to use your real credentials.

If the login is successful, you'll continue to add the bank account by selecting it from the displayed list.

Add the bank account

The final step for adding the bank account is to select the desired account from the list of accounts pulled from your bank. You'll also need to select the account type and then click on Confirm to finalize the setup.

The bank accounts that you added can be found on the Settings page. You can add another account by clicking on the button highlighted below and the dialog asking you to choose between Manual Verification and Instant Verification will be displayed.

Updated about a year ago

Instant Account Verification


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.