API reference

Error code: consent_required

consent_required returns HTTP 422 with type: invalid_request_error. The consent gate was not satisfied. When it is about one field, error.param points at fields.consent. Branch on this code — it is stable — and apply the fix below.

2 min read

422HTTP status
consent_requirederror.code
FixHandling

What triggers it

The consent gate was not satisfied. fields.consent missing or not equal to the string "yes".

Example response

{
  "error": {
    "type": "invalid_request_error",
    "code": "consent_required",
    "message": "The consent gate was not satisfied.",
    "param": "fields.consent"
  }
}

How to fix it

Collect explicit consent and send fields.consent: "yes".

This is deterministic: the same request will fail again until fixed. See the HTTP 422 page for the class.

In practice

In a well-built client, consent_required is handled by branching on error.code rather than on the human error.message, which may be reworded over time. The HTTP status (422) gives the broad invalid_request_error class; the code gives the specifics; and, on field errors, error.param pinpoints the input to fix.

This code is deterministic — retrying the identical request reproduces it — so keep it out of your retry path and instead map it to a clear, actionable message. See Map errors to user-facing messages and Read the error envelope for the pattern.

Frequently asked questions

Is consent_required safe to retry?

No. It is deterministic; retrying the identical request produces the identical error. Fix the cause first.

Will this code ever change?

No. Error codes are stable contract. The human message may be reworded, but the code you branch on will not change.

Do I branch on the code or the HTTP status?

Both — the status for the retry-or-not decision, the code for the specific behaviour. See the error envelope.

Funding for UK limited companies

Credicorp lends to your company, not to you personally — short-term working capital with no personal guarantee. See what your business could access.