Errors
Errors are RFC 9457 problem details (application/problem+json):
{ "type": "https://developers.lexopti.com/errors/not_found", "title": "Not Found", "status": 404, "code": "not_found", "detail": "No such client.", "request_id": "req_4f9c2a7d1e6b4c08a3f5d2e9b7c1a604"}Branch on code, never on detail. request_id is the request’s id, the same as its Request-Id header: log it, and quote it when you write to LexOpti support about a failed request (request ids).
| Code | Status | Meaning |
|---|---|---|
validation_failed |
400 | invalid body or query, such as a malformed events position or after with cursor; errors[] lists the fields, when the error is about fields |
bad_request |
400 | a request LexOpti cannot carry out as sent, such as a check no source applies to; detail says why |
incomplete_identity |
400 | complete the identity before a check; missing[] lists the fields |
invalid_cursor |
400 | cursor of another list, or whose row is gone; events position beyond the feed |
idempotency_key_required |
400 | the operation needs an Idempotency-Key |
invalid_idempotency_key |
400 | the Idempotency-Key is not 1 to 255 printable ASCII characters |
invalid_webhook_url |
400 | the webhook URL is not an HTTPS URL LexOpti can deliver to |
invalid_origin |
400 | the embed session’s origin is not a valid https://host[:port] |
component_not_available |
400 | the embed session asks for a component this deployment does not serve (it serves every component: client, case, clients, cases, app, new-client and new-case) |
invalid_features |
400 | an embed session feature is not one of its component’s |
invalid_token |
401 | missing, invalid or expired token, or access ended |
insufficient_scope |
403 | the token lacks the operation’s scope |
readonly_member |
403 | the member has a read-only role |
forbidden |
403 | the member cannot act on this resource, such as an alert of a client they cannot access |
quota_exceeded |
403 | the credits cannot pay the dossier the check is charged to (it opens, grows past its places or renews), or the organization is read-only (no check, no new client) |
subscription_inactive |
403 | no offer runs: the organization’s credits are frozen and no check can be charged until it subscribes again |
dossier_required |
400 | the client has several open cases: send one of cases as case_id |
embed_not_enabled, origin_not_allowed |
403 | embedding not set up for this origin |
sandbox_required |
403 | the operation runs in sandbox organizations only: a test trigger, or an embedded session of an application that opens them in sandboxes only, as the portal’s own client does for the playground |
installation_required |
403 | the operation is for an application an owner or admin installed for the whole organization: GET /v1/members (a whole organization) |
not_found |
404 | not in the token’s organization, or no such route |
idempotency_request_in_progress, idempotency_secret_withheld, idempotency_response_unavailable |
409 | see requests |
check_launch_in_progress |
409 | the check’s first launch is still running: retry later with the same key and body (meanwhile, a retry answers idempotency_request_in_progress) |
preliminary_screening_pending |
409 | a preliminary screening of the client is already running: read its result once it settled, or ask again then |
external_ref_conflict |
409 | the external_ref already names another client or case of your application: nothing was created or changed (your own ids) |
case_closed |
409 | the case is closed, read only for good: nothing is launched or changed in it |
conflict |
409 | another launch of the same client’s checks is running: retry later |
too_many_webhook_endpoints |
409 | 10 webhook endpoints already (enabled or disabled), for your application in this organization: nothing was created; delete one you no longer use (DELETE /v1/webhook-endpoints/{id}, webhooks) |
idempotency_key_reused |
422 | the key was used for another request |
preliminary_screening_unavailable |
503 | preliminary screening is not available on this deployment, or its official lists are not loaded yet: nothing was asked, retry later |
rate_limited |
429 | wait Retry-After seconds |
internal_error |
500, 503 | retry later |