Skip to main content

Getting Started

This guide walks you through making your first API call to the Tidely Partner API.

Quick start with Postman​

The OpenAPI spec includes example request bodies and responses for every endpoint. Import it directly into Postman to get a ready-to-use collection — no separate download needed, and it always stays in sync with the latest API.

  1. In Postman, click Import → Link → paste the spec URL for your environment:
    • Production: https://developers.tidely.com/spec/partner-api.yaml
    • Staging: https://developers.sam.tidely.com/spec/partner-api.yaml
  2. Postman generates a collection with every endpoint and pre-filled example bodies.
  3. Select the collection → Authorization tab → type OAuth 2.0 → fill in:
    • Grant Type: Client Credentials
    • Access Token URL: https://auth.tidely.com/oauth2/token (or https://auth.sam.tidely.com/oauth2/token for staging)
    • Client ID / Client Secret: your credentials
  4. Click Get New Access Token → Use Token. All requests inherit it automatically.

Or keep reading for a raw HTTP walkthrough.

1. Obtain Client Credentials​

Contact partnerships@tidely.com to register as a partner and receive your OAuth 2.0 client credentials (client_id and client_secret).

2. Obtain an Access Token​

Exchange your client credentials for an access token:

curl -X POST https://auth.tidely.com/oauth2/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

A successful response:

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600
}

3. Verify Your Authentication​

Test your access token with the authentication endpoint. All partner API requests require the X-Account-Id header to specify which customer account to operate on (see Tenant Context):

curl -X GET https://api.tidely.com/partner/v2/authentication/verify-auth \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Account-Id: 12345"

4. List Bank Accounts​

Retrieve bank accounts for a customer:

curl -X GET https://api.tidely.com/partner/v2/bank-accounts \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Account-Id: 12345"

5. Create a Financial Plan​

Create a monthly financial plan for a customer:

curl -X POST https://api.tidely.com/partner/v2/plans \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Account-Id: 12345" \
  -H "Content-Type: application/json" \
  -d '{
    "categoryName": "E-Commerce Revenue",
    "amount": 50000.00,
    "period": "MONTHLY",
    "date": "2025-01-01",
    "type": "ONE_TIME",
    "name": "January Revenue Target"
  }'

Base URLs​

EnvironmentURL
Productionhttps://api.tidely.com/partner/v2
Staginghttps://api.sam.tidely.com/partner/v2

Next Steps​