Where can I see an example API integration workflow?

Example Workflow

Here’s an example sequence for a typical integration:

1. Authenticate: obtain an OAuth2 access token using your client credentials.
2. List Corporates: call GET /v1/corporates to retrieve the list of available corporate entities.
3. Get Corporate Details: use the id from the list to call GET /v1/corporates/{id} for detailed information.
4. List Operating Entities: use a corporate’s id as a filter with GET /v1/entities?CorporateId=....
5. Retrieve Account Information: ccall GET /v1/accounts (optionally filtered by EntityId) to retrieve account data, then get specific account details, balances, and statements as needed.
6. Manage Cards & Expenses: use the card endpoints to list cards, retrieve detailed card information, and view expense and receipt details.

Playbook Links

1. Environments & Base URLs
2. Authentication
3. Endpoints:
   1. Corporate Endpoints
   2. Entity Endpoints
   3. Account Endpoints
   4. Card Endpoints
4. Response Envelopes
5. Error Handling
6. Best Practice & Tips
7. Example Workflow