Get whether a consignado contract is still alive under the tenant

Answers whether the contract is still alive under the tenant, how it came to exist and, when it is not alive, why it left.

alive is the very proposition the command gates (suspensão, reativação, alteração de termos, antecipação, refinanciamento, renegociação, exclusão de portabilidade, CCB read) evaluate: a contract the gates refuse with 404 is alive=false here, so a client can hide the commands that would be refused.

arrival.kind is the first arrival that holds, in the order averbacao, refinanciamento, renegociacao, importacao, and arrival.at is when it settled. exit is null exactly when alive is true; otherwise it names the exit with the earliest instant among those that hold, and on a tie the order is exclusao_portabilidade, reversao_refinanciamento, exclusao, saida_dataprev.

A number the tenant never held answers 404 CLT-0005, the refusal the command gates use. It answers from local tables and never reaches Dataprev; the tenant comes from the validated identity.

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

Get whether a consignado contract is still alive under the tenant

cURL

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

200

{
  "alive": true,
  "arrival": {
    "at": "2023-11-07T05:31:56Z",
    "kind": "averbacao"
  },
  "exit": {
    "at": "2023-11-07T05:31:56Z",
    "reason": "exclusao"
  },
  "numero_contrato": "<string>"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

numero_contrato · string · requerido

Client contract identity within the authenticated tenant.

Required string length: 1 - 20

Ejemplo:

"contract-1"

Respuesta

200

application/json

OK

alive · boolean · requerido

True exactly when the command gates accept the contract; false once it left the tenant's registry.

arrival · object · requerido

How the contract came to exist under the tenant.

Show child attributes

exit · object | null · requerido

Why and when the contract left; null while it is alive.

Show child attributes

numero_contrato · string · requerido

The contract number, as in the path.