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

Test in Sandbox

Go to Sandbox

For testing in Sandbox, you first need to go to your Sandbox environment. Click on the Settings link found on the account dropdown:

On the Settings page go to the Developer tab from the menu panel and click on GO TO SANDBOX to switch to your Sandbox environment:

A modal will be displayed and you'll need to confirm your choice:

Once in Sandbox, you'll have a button to go back to the Live environment:

Email verification code

When you'll switch to Sandbox for the first time, you'll be prompted to verify your email by entering a verification code that you receive by email. That code is always 123123 in Sandbox.

Get the API keys

On the Sandbox Settings page you can find your Sandbox API keys:

API keys by environment

The API keys are different in each environment.You need to use your Sandbox keys in the Sandbox environment and your Production keys in the Production environment.

As you can see in the image above, there's a Delete data button, only available in Sandbox for testing purposes. It allows you to delete all of your transaction data from the Sandbox environment.

Add a bank account

Now that you have the Sandbox API keys, you can add a bank account using the Sandbox API. Make sure to use the proper Authorization header:

Authorization: YOUR_SANDBOX_API_KEY:YOUR_SANDBOX_SECRET_KEY

Using the API

At this point, you can follow the instructions for adding a Bank Account using the API. You can either use Manual Verification or Instant Account Verification. Whenever there are Sandbox specific instructions, you will see a disclaimer like this:

Sandbox testing

On the Sandbox environment, the micro-deposits values are always 0.07 and 0.15

Using the Web Interface

If you prefer adding a bank account using our web interface, we simplified the process for you by pre-filling the account information. If you haven't already, you will first need to select your profile type, which can be either Individual or Business.

For the first bank account, you can choose to add a dummy account by just clicking the Confirm button that you see here:

Or, if you want to go through the usual process of adding a Bank Account you can do that too by clicking on the other button. You can either use Manual Verification or Instant Account Verification.

Instant Account Verification

If you use the Web Interface, depending on what bank account you select from the list, we will display one of the two following forms for logging in to your bank:

Plaid form

If you see this form, you will need to 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.

Checkbook form

If you see this form, you will need to 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.

Test in Sandbox


Suggested Edits are limited on API Reference Pages

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