Welcome to the Acclaim API reference. This reference provides technical details for integrating with Acclaim’s platform, including endpoints, parameters, and response formats.

Base URL

All API requests are made to the following base URL:

https://api.withacclaim.com/v1

Requests must be made over HTTPS. Unencrypted HTTP is not supported.

Data Format

The API is JSON-only. Requests should include the following header:

Content-Type: application/json

Responses are always returned in JSON.

You can read our API Conventions guide to learn more about how specific data types are formatted, such as, dates, monetary values, and object IDs.

Versioning

As Acclaim evolves, new fields may be added to responses without notice. Removing or renaming fields will only occur in a versioned API release. You can safely ignore fields your integration does not recognize.