Reference

Errors

A rejected call still answers with HTTP 200. The body tells you whether it worked, so always check status before reading anything else.

The shape of a failure

200 OK (rejected)

{
  "status":  "error",
  "message": "email is required"
}

Field	Type	Notes
status	string	`error` on a rejected call, `success` otherwise.
message	string	What was wrong. Safe to log, not always safe to show a customer.

Do not rely on the HTTP status code to detect failure. Branch on status in the body.

Error messages

Message	Meaning	What to do
Invalid request method	The call was not a `POST`.	Send a `POST`.
Invalid JSON payload	The body could not be parsed as JSON.	Send valid JSON with `Content-Type: application/json`.
Suspicious activity detected	A field failed input checks: script or SQL-like content, a value over 500 characters, an invalid email, or a phone number that is not 10 to 15 digits.	Check `email` and `phone` first, then remove unusual characters from other fields.
`<field>` is required	A required field is missing or empty.	Add the named field. See Create account.
Invalid API keys	The `api-key` and `secret-key` pair was not accepted.	Check both headers and that they belong to the same key pair.
The reference '`<ref>`' has already been used for this business.	You have already created an account with this `ref`.	Use a new `ref`.
Internal Server Error	Something failed on our side.	Retry with a backoff. If it persists, open a ticket with your `request_ref`.

Partial results

When you request several banks, each one is handled on its own. If a bank could not issue an account, it is left out of results and the call can still answer status: "success". Compare results against the banks you requested rather than assuming every one came back.

When a call will not work

Are both api-key and secret-key present, spelled exactly as documented?
Is the body valid JSON, with Content-Type: application/json?
Are all required fields present, with a valid email and a 10 to 15 digit phone?
Is the ref new? A reused ref is rejected.

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.