API Workflow & Setup

This document outlines the standard (Happy-path) flow for the BAI Accounts API. It explains how to retrieve account lists and details.

To test error scenarios, see Try it Out (Sandbox).

Before you begin

Before you retrieve account data, you should to meet the following requirements.

Sandbox Requirements

Set up a sandbox account
Set up sandbox application and subscription to either:
- Business Account Insight Sandbox
Set up your Mutual TLS connection, you can find our example certificates for sandbox here.
Set up your signing flow, you can find our example certificates for sandbox here.
Set up your Oauth flow

Production Requirements

Set up a production account. To get a production account, see Go to Production
Set up production application and subscription to either:
- Business Account Insight
Set up your Mutual TLS connection with your EV SSL certificate
Set up your signing flow with your EV SSL certificate
Set up your OAuth flow

You are required to sign the payload for GET (read account list / details) requests.

📘
Read our Validate Signing Requests documentation for a detailed description of our signing method.

Required headers to include in your requests are:

Name	Description	Format
Date	The date in a RFC-compliant date/time format.	String
Digest	The digest is a base64 encoded hash of the body.	String
X-Request-ID	The X-Request-ID is a UUID generated by you.	UUID
Signature	The signature is the signing string signed with your private key.	String
Signature-Certificate	The signature certificate is the public part of your EV SSL signing certificate.	String
X-IBM-Client-ID	The X-IBM-Client-ID is a UUID generated by your application.	UUID
Authorization	The Authorization header should include your access token.	String