Read the exclusion this gateway holds for a contract

Reads the exclusion this gateway durably holds for one contract — the outcome of excluir-consignado-trabalhador (Manual 003 v1.21 §3.3). It is a LOCAL read: it never calls Dataprev and never starts a reconciliation pass, because the gateway’s own row already answers and an M003 operation with no undo does not justify spending the rail’s rate budget on the question.

404 means the gateway holds nothing for this contract.

GET /v1/consignado/contracts/{numero_contrato}/exclusion

Read the exclusion this gateway holds for a contract

cURL

curl --request GET \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/contracts/{numero_contrato}/exclusion \
  --header 'Authorization: Bearer <token>'

200

{
  "motivoExclusao": "1",
  "numeroContrato": "99999999999AN1",
  "status": "confirmed",
  "evidenceSource": "exclude_response",
  "message": "motivo nao publicado",
  "outcomeAt": "2026-08-05T12:00:00Z",
  "providerReference": "HASH-1",
  "reasonCode": "ME"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

numero_contrato · string · requerido

The rail contract number whose exclusion is read.

Required string length: 2 - 15

Ejemplo:

"99999999999AN1"

Respuesta

200

application/json

The exclusion operation that describes the contract now.

motivoExclusao · enum<string> · requerido

The client's declared Manual 003 §3.3.1 reason, echoed from the durable authority.

Opciones disponibles: 1, 2, 3, 7, 8, 9

Ejemplo:

"1"

numeroContrato · string · requerido

The contract number Dataprev was asked to exclude: the number asked for, or the one a renegociação gave that contract.

Ejemplo:

"99999999999AN1"

status · enum<string> · requerido

Durable operation status. confirmed means the contract came off the payroll; rejected means the exclusion did not run: the registry published a refusal, or its contract read showed the contract already off the registry by another way; claimed, invoking and outcome_unknown all mean the effect at the registry is NOT known yet and M005 reconciliation has to close it — none of the three is a failure to retry blindly.

Opciones disponibles: claimed, invoking, confirmed, rejected, outcome_unknown

Ejemplo:

"confirmed"

evidenceSource · string

Which proof produced the terminal state: exclude_response, operator_evidence or m005_observation. Empty until one did.

Ejemplo:

"exclude_response"

message · string

The refusal message the REGISTRY published, or the gateway's account of the contract read that closed it. Present only on a rejected operation.

Ejemplo:

"motivo nao publicado"

outcomeAt · string<date-time>

Instant the registry answered, RFC 3339 UTC. ABSENT until it did.

Ejemplo:

"2026-08-05T12:00:00Z"

providerReference · string

The registry's own receipt for the mutation. ABSENT when it minted none, which is the normal case under an m005_observation confirmation — absence is never a verdict.

Ejemplo:

"HASH-1"

reasonCode · string

The refusal code the REGISTRY published, or contract_left_registry.situacao_N[.origem_N] when its contract read showed the contract already off the registry. Present only on a rejected operation.

Ejemplo:

"ME"