Skip to main content
MasterID returns a consistent JSON envelope for every API call. Learn the difference between the request ID, the session ID, and the collection reference so you route results correctly in your integration.

Success envelope

A completed request returns HTTP 200 with a JSON object containing id and data.
string
The API request ID. Every response, including errors, includes this value.
object
The operation payload. Its shape depends on the endpoint.

Example: wallet balance

Error envelope

An error response returns { id?, error }. The id field is present when MasterID generated a request ID before detecting the failure.
For per-code troubleshooting, see Errors.

Pending response (202)

Operations that finish asynchronously return HTTP 202. The envelope still contains id and data, but the data indicates the operation is processing.
  • Verification submissions return a sessionId and a pending status.
  • Collection requests return a reference and a pending status.
Store the returned identifier (session ID or reference) and poll or wait for the webhook. Do not submit the same request again with a different key.

Request ID vs session ID vs collection reference

The request ID and the session ID are different values. Store the session ID or collection reference so you can retrieve final results later.

Unauthenticated browser visits

If you open an API URL in a browser without credentials, MasterID returns service information only. No workspace data, balance, or records are exposed.

Response-handling helper

Use a small helper to normalise every response and extract the request ID for logging.
Always log the request ID. It makes support requests faster when you need to trace a specific call.