Getting Started with ACC API

To help developers quickly get started, we’ve provided a Postman Collection that demonstrates how to authenticate and interact with the ACC service.

Visit Download page to download the postman collection!

About the Postman Collection

The Postman collection contains:

• Fields to enter your client_id and client_secret
• Built-in OAuth 2.0 token generation request
• A variety of pre-configured endpoints to test core functionality

💡 Note: All requests are secured and require a valid Bearer token generated using the client credentials.

Step-by-Step: Making Your First Request

1. Import the Postman Collection

• Download the ACC Postman collection JSON file from the provided location (internal or GitHub).
• Open Postman, then click “Import” → “File” and upload the collection.

2. Set Environment Variables

The Postman collection includes pre-defined environment variables for ease of setup. Please ensure the following variables are correctly set in your Postman environment:

Variable Name	Description	Required
clientId	Provided by Alkami for your FI	✅ Yes
clientSecret	Provided by Alkami for your FI	✅ Yes
apiKey	Provided by Alkami for your FI	✅ Yes
baseUrl	Base URL of the ACC API (e.g., https://api.dev.alkami.com)	✅ Yes
customerId	Test customer ID to use in certain requests	⚪ Optional
accountId	Test account ID for account-based requests	⚪ Optional

⚪ Setting customerId and accountId is optional but recommended for quicker testing of Customer and Accounts endpoints.

✅ The values for clientId and clientSecret and apiKey must be updated with credentials provided to you. Reach out to your CSM if don’t have them.

3. OAuth Token Generation (Automatic)

The Postman collection is configured to automatically generate an OAuth 2.0 token using a pre-request script.

When you send any API request (e.g., /Health, /customer-reference-data, etc.), the script will:

• Use your clientId and clientSecret and apiKey
• Call the OAuth token endpoint
• Save the resulting access_token to the environment variable {{accessToken}}

4. Test Basic Connectivity: /Health Endpoint

• Navigate to the /Health request in the collection.
• Click Send.
• A successful boolean response returns the operational status of the mapped core system.

5. Retrieve Customer Accounts: /customer-reference-data/:customerId/accounts

This endpoint is used to retrieve all accounts associated with a specific customer.

• The :customerId path parameter is automatically populated using the {{customerId}} variable from the Postman environment.
• Ensure that you input a valid customerId that exists in your core system before making the request.

📌 Tip: You can set the customerId variable once in your environment, and it will automatically populate wherever needed.

A successful response will return a list of accounts linked to the customer, including account IDs, types, and status.