Reference

Errors

A rejected call answers with a non-2xx status and a body that says what was wrong. Read the body, not just the code.

The shape of a failure

400 Bad Request

{
  "success": false,
  "message": "Email parameter is required",
  "data":    null
}

Field	Type	Notes
success	boolean	`false` on a rejected call.
message	string	What was wrong. Safe to log, not always safe to show a customer.
data	null	Empty on failure.

Status codes

Code	Meaning	What to do
200	The call succeeded.	Check `status` in the body before reading the rest.
400	The request was rejected, usually a missing or invalid field.	Read `message`. Retrying the same body will not help.
401	The credentials were not accepted.	Check all four headers, and that the keys match the environment you are calling.
5xx	Something failed on our side.	Retry with a backoff. If it persists, open a ticket with your `request_ref`.

When a call will not work

Are all four headers present, spelled exactly as documented?
Are you using the key pair for the environment you are calling?
Is the business active? Live collections stay closed until verification is complete.
Is the body valid JSON, with Content-Type: application/json?

Still stuck? Open a ticket from Live Support in your dashboard and include the request_ref from the response. It lets us find the exact call in our logs.