Try the API

The API reference and client tools use the same OpenAPI JSON. Use it to generate a client or import requests into Postman or Bruno. The public API base URL is https://{{API_HOST}}. Obtain an access token through API essentials → Authentication.

Download the contract

Choose your version using API version in the header. In API reference → Introduction, select Export → OpenAPI Spec, or use Download OpenAPI JSON on API map. Both downloads match the selected version. Save the file as openapi.json.

Generate an API client

Use the downloaded contract with a generator that supports OpenAPI 3.1. Choose the language and library that fit your application, and follow the generator's official documentation:

• OpenAPI Generator installation.
• Client generation and CLI usage.
• Supported generators, languages and options.

Configure your tool

Import the downloaded contract. Set BASE_URL to your gateway URL and store ACCESS_TOKEN in the tool's secret storage. Obtain the token with your client ID and secret, then use Bearer authentication for API requests.

Postman

• Import the OpenAPI contract into Postman.
• Configure Postman variables.
• Store the Postman access token as a secret.
• Configure Postman Bearer authentication.

Bruno

• Import the OpenAPI contract into Bruno.
• Configure Bruno variables.
• Store the Bruno access token as a secret.
• Configure Bruno Bearer authentication.

BASE_URL is the onboarding HTTPS resource gateway URL, without a trailing slash or the /v... endpoint path. Resource operations inherit that API server, while the token operation has its own server for the separately configured authentication endpoint https://{{AUTH_HOST}}/oauth2/token. If the root server contains an apiHost variable, replace API_HOST with your onboarding API hostname. Keep real tokens out of shared collections.

Make a request

Follow API essentials → Your first request for the operation, path and expected response. Use API map to explore other endpoints and Errors and problem codes to interpret failures. Resource identifiers, such as CCVs and ISINs, come from discovery in your environment.