Quick Start

1: Retrieve your API keys

Log in or create an account with the Abound Dashboard to find and retrieve your API keys.

API keys are environment specific and can be found on the Keys page.


2: API authentication

Authentication requires passing your bearer token for the desired environment (sandbox or production) in the Authorization header of your API request.

The bearer token is in the format of: appId.appSecret

The following is an example request that returns all Tin Verifications with the required Authorization header.

1curl \
2  --request GET \
3  --url https://sandbox-api.withabound.com/v4/tin-verifications \
4  --header 'Accept: application/json' \
5  --header 'Authorization: Bearer appId_sampleqNhVcdYQYU.appSecret_sampleMz2Zbj3Hq'
ValueDescription
appIdA non-sensitive, public identifier that is used to identify your app.
appSecretA sensitive, private key used to make secure calls to the Abound from your backend. Your appSecret should never be shared on the client-side or stored directly in your code.
sandbox-api.withabound.com/v4Sandbox API environment; use test credentials and build out and test your integration.
production-api.withabound.com/v4Production API environment; this environment is billed and will initiate real interactions with government entities.

3: Make your first sandbox API call

As an example, let’s perform a test Tin Verification to see if Ada Lovelace’s tax identification number is 111-11-1111.


tin test values

In this example, 111111111 is one of our many sandbox tin test values. A complete list of tin test values can be found here.


a. Request a new Tin Verification.

To request a new Tin Verification call POST /tin-verifications.

1curl \
2  --request POST \
3  --url https://sandbox-api.withabound.com/v4/tin-verifications \
4  --header 'Accept: application/json' \
5  --header 'Authorization: Bearer appId_sampleqNhVcdYQYU.appSecret_sampleMz2Zbj3Hq' \
6  --header 'Content-Type: application/json' \
7  --data '{
8    "name": "Ada Lovelace",
9    "tin": "111111111"
10  }'

b. Save the response

The response from POST /tin-verifications is shown below and it’s a match!

Ensure that you save the tinVerificationId and the tinFingerprint to your own database for future reference.

JSON
1{
2  "id": "tinVerificationId_sample41SD71AV8f",
3  "createdAt": "2023-01-01T00:00:00.000Z",
4  "status": "MATCH",
5  "name": "Ada Lovelace",
6  "tin": "xxxxxxx11",
7  "tinType": "INDIVIDUAL",
8  "tinFingerprint": "tinFingerprint_samplehy2BWO6JJG"
9}