Consignado error list

Error format Lerian Consignado returns errors as RFC 9457 problem details with the application/problem+json media type:

{
  "code": "CLT-0006",
  "detail": "The worker's authorization is outside its validity window, so their payroll data can no longer be read under it. Obtain a fresh worker authorization and send its evidence; repeating this request cannot succeed.",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "https://errors.lerian.studio/v1/CLT-0006"
}

Field definitions

type – A URI that identifies the error in the Lerian error catalog. Built as https://errors.lerian.studio/v1/<code>.
title – The HTTP status text (for example, Unprocessable Entity).
status – The HTTP status code.
detail – A human-readable explanation of this occurrence. On a 5xx response Consignado sanitizes the detail to internal error, so an internal cause stays out of the body. Branch on code and on the status instead.
code – A stable identifier for the error. The tables below list the CLT-NNNN codes. Some operations answer a named code of their own, such as CURSOR_EXPIRED on the registration inventory sweep. A request that fails schema validation carries no code: it answers 422 with the detail validation failed, or 400 when the body cannot be parsed, and the errors list names each field.
errors – Optional list of individual error details, each with a location, a message, and a value.
upstream – Dataprev’s own error, when the gateway relays one. It holds Dataprev’s code and message, and it survives the 5xx sanitization that clears detail. See Dataprev reason codes.
refusal – On a bid refusal: the reason the gateway recorded for the bid, with its source, field, rule, and detail. A refusal from Dataprev also carries Dataprev’s code.

400: Bad request

`code`	Description	`detail`
CLT-0001	Invalid request. For example, a credentials request carries a requester code that is not three digits, or a certificate and key that are not a valid PEM pair. A request with an `X-Idempotency` key longer than the operation accepts also gets this code. A disbursement confirmation answers a key that is too long with `422`. A request that fails schema validation carries no code.	—
CLT-0011	Request failed. The fallback code for a client-side refusal with no entry of its own.	Names the refusal.

401: Unauthorized

`code`	Description	`detail`
CLT-0003	Unauthorized. The request carried no valid bearer token, or the gateway could not resolve a tenant from it.	`Unauthorized`, or `Authentication is required to access this resource.`

403: Forbidden

`code`	Description	`detail`
CLT-0004	Forbidden. The authenticated caller does not hold permission for this operation.	`Forbidden`

404: Not found

`code`	Description	`detail`
CLT-0005	Not found. The record the request named does not exist for this tenant. A retained artifact owned by another tenant answers the same way.	`Not Found`, or `The requested resource was not found.`

409: Conflict

`code`	Description	`detail`
CLT-0007	Conflict. The request conflicts with the current state of the record.	`Conflict`, or the sentence for the conflict, such as `an identical request is already in flight`.

CLT-0007 with the detail an identical request is already in flight marks a request the gateway has not finished. Retry that request under the same idempotency key. Command conflicts answer a named code in place of CLT-0007, so a client can tell them apart. Read code and detail together before you retry. These code spellings are part of the wire contract and do not change.

After DATAPREV_CREDENTIAL_REQUIRED, upload the tenant’s Dataprev certificate, OAuth credentials, and requester code, then send the request again.

410: Gone

The paginated registration inventory sweep issues a cursor with a limited retry window.

`code`	Description	`detail`
CURSOR_EXPIRED	Gone. The cursor’s retry window has passed, so the sweep it belonged to cannot continue. Start a new sweep instead.	The cursor retry window has expired.

413: Request entity too large

`code`	Description	`detail`
CLT-0010	Request entity too large. The request payload is larger than the endpoint accepts.	`The request payload is too large.`

422: Unprocessable entity

`code`	Description	`detail`
CLT-0006	Unprocessable entity. The gateway read the request and refuses it in its current form. A deterministic Dataprev rejection answers here too, and carries `upstream`.	The reason to act on, such as obtaining a fresh worker authorization.

A command sent again under an idempotency key that an earlier request already spent can answer one of four named codes. The earlier request can already have reached Dataprev. Do not send the command again, under this key or a new one. Read the current state of the record the command changes.

`code`	Description	`detail`
IDEMPOTENCY_STATE_UNRECOGNISED	The record held under this key was written by a newer version of the service.	An earlier request spent this idempotency key with a record written by a newer version of this service; reconcile the original request and do not retry under a new key.
IDEMPOTENCY_RECORD_UNREADABLE	The record held under this key cannot be read.	An earlier request spent this idempotency key with a record this service cannot read; reconcile the original request and do not retry under a new key.
IDEMPOTENCY_OUTCOME_UNRECORDED	The earlier request under this key has no recorded outcome.	An earlier request spent this idempotency key and its outcome was not recorded; reconcile the original request and do not retry under a new key.
IDEMPOTENCY_REPLAY_UNAVAILABLE	The earlier request under this key completed, and its answer cannot be replayed.	An earlier request with this idempotency key completed and its response was delivered once, but it cannot be replayed; do not resend, reconcile the resource the command mutates, and do not retry under a new key.

429: Too many requests

`code`	Description	`detail`
CLT-0009	Too many requests. The caller exceeded its request budget.	`Too many requests were sent in a given amount of time.`

Wait for the time the Retry-After header gives, then send the request again.

500: Internal server error

`code`	Description	`detail`
CLT-0002	Internal server error. An unexpected failure inside the gateway.	`internal error`

501: Not implemented

A 501 answers an operation your deployment has not enabled. The routes stay mounted, so the answer arrives per request rather than as a missing path. Contract artifact downloads, contract corrections, disbursement confirmation, cessão registration, bid submission, and operations that reach Dataprev answer 501 until your deployment enables them. The detail reads internal error, because Consignado sanitizes the detail on a 5xx response. Branch on the status.

503: Service unavailable

`code`	Description	`detail`
CLT-0008	Service unavailable. A dependency the request needs is unavailable, or Dataprev answered with a retry-later fault. Send the same request again shortly.	`internal error`

When Dataprev produced the fault, the response also carries upstream with Dataprev’s own code and message.

Dataprev reason codes

Consignado relays Dataprev’s reason codes rather than mapping them onto codes of its own. That keeps a refusal readable against what Dataprev said. Read each reason code against Dataprev’s specification, not against this page. Dataprev can publish a code this page does not list, and the gateway still delivers it to you. They reach you in two places. On a refusal. The upstream member carries Dataprev’s own code and message. A refusal with several codes lists them comma-separated. The member holds Dataprev’s codes and sentences, bounded in length, rather than a response body. A 422 carries it for a deterministic rejection, and a 503 carries it for a retry-later fault. On contract and margin responses. Several response fields pair a Dataprev reason code with Dataprev’s own label for it. A margin read publishes blockType and ineligibilityReason, which spell the pair code and description. A contract read publishes motivo_exclusao, origem_averbacao, origem_exclusao, portabilidade_situacao, and situacao_bloqueio_garantia, which spell it codigo and descricao. Each field holds a numeric code and the text Dataprev returned beside it. Treat the set as open. Map the reason codes your integration acts on, and pass the rest through with their labels, so a code you have not mapped yet stays readable to an operator.

Tenant setup and credentials

Worker data and margin

Auctions and proposals

Contract registration and documents

Contract corrections

Contract lifecycle

Refinancing, renegotiation, and portability

Legacy contracts

FGTS guarantees

Reconciliation and calendar

Funds and assignments

Capacity and usage

Monitoring

Event subscriptions

Error handling

Events

Consignado error list

400: Bad request

401: Unauthorized

403: Forbidden

404: Not found

409: Conflict

410: Gone

413: Request entity too large

422: Unprocessable entity

429: Too many requests

500: Internal server error

501: Not implemented

503: Service unavailable

Dataprev reason codes

​400: Bad request

​401: Unauthorized

​403: Forbidden

​404: Not found

​409: Conflict

​410: Gone

​413: Request entity too large

​422: Unprocessable entity

​429: Too many requests

​500: Internal server error

​501: Not implemented

​503: Service unavailable

​Dataprev reason codes

400: Bad request

401: Unauthorized

403: Forbidden

404: Not found

409: Conflict

410: Gone

413: Request entity too large

422: Unprocessable entity

429: Too many requests

500: Internal server error

501: Not implemented

503: Service unavailable

Dataprev reason codes