API basics
Base URLs
Every endpoint path in this documentation is relative to an environment's base URL. Pick the environment, then append the path.
- Version
/api/v1- Transport
- HTTPS
- Format
- JSON
- Auth
X-API-Key
Environments
| Environment | Base URL |
|---|---|
| Production | Provided at onboardingMutual TLS required |
| Sandbox | https://staging-api.emergentriskinternational.com/api/v1Same contract as production |
| Local | http://127.0.0.1:3001/api/v1apps/backend on your machine |
- Production serves your live integration. Its base URL is provided at onboarding, and every connection needs an ERI-issued client certificate (mutual TLS).
- Sandbox runs the same contract as Production. Build and test against it. The "try it" console in the API reference is set to it by default.
Build a request URL
The API version is part of the base URL, so the paths in the reference start after it. GET /reports on Sandbox is:
https://staging-api.emergentriskinternational.com/api/v1/reports
Path parameters are filled in place, for example /reports/{id}. Query parameters follow the usual ?name=value form, and a filter that takes several values is repeated: ?region=Europe®ion=MENA.
Request conventions
| Convention | What to send or expect |
|---|---|
| Authentication | An X-API-Key header on every request. See Authentication. |
| Content type | Request and response bodies are JSON. A request with a body must declare its type (Content-Type: application/json); without the header it gets 406. |
| Body size | Request bodies up to 500 kB. |
| Timestamps | ISO 8601 with an explicit UTC offset, for example 2026-07-03T14:30:00Z. |
| Errors | A JSON body with statusCode and message. Business errors such as 401, 403 and 409 add a stable code to branch on; validation 400s list the failing fields in errors. |
| Correlation ID | Send a correlation-id header to trace a request end to end. Without one, the response carries a generated correlation-id. |
Environment variables
The code samples in these guides read two variables:
| Variable | Value |
|---|---|
CORE_API_BASE_URL | The base URL of the environment you call |
ERI_API_KEY | Your API Key, as issued by ERI support |
Terminal
export CORE_API_BASE_URL="<base URL from the table above>"
export ERI_API_KEY="<your API Key>"