> For the complete documentation index, see [llms.txt](https://docs.giro.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference/operacoes-fgts/submeter-operacoes/submeter-averbacao.md).

# Averbação (Legado)

{% hint style="danger" %}
**Legado.** Este endpoint isolado não deve ser usado em novas integrações. A averbação hoje é orquestrada pelo fluxo de [**Contratos (Formalização)**](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference/contratos.md) — veja [Submeter Contrato](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference/contratos/submeter-contrato.md) e [Fluxo de formalização](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/fluxo-formalizacao.md).
{% endhint %}

Admite uma operação de averbação FGTS de forma assíncrona com prioridade `NORMAL`. Os campos `contractNumber` (número do contrato), `operationKind` (tipo de reserva) e `periods` (parcelas a averbar) vão no nível superior do corpo, junto com `cpf`. Quando concluída com sucesso, o resultado conterá um protocolo gerado pela Caixa.

{% hint style="info" %}
Esta operação é **assíncrona**: a resposta `202` confirma apenas a admissão. O resultado chega depois via [webhook](https://docs.giro.tech/desenvolvedores/api-gtfgts/webhooks/payloads.md) ou por [polling](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference/operacoes-fgts/acompanhar-resultado/consultar-status-operacao.md) do `requestId`.
{% endhint %}

## Request

`POST /api/v1/fgts/endorsements`

Autenticado: `Authorization: Bearer {originatorToken}`.

### Parâmetros

| Parâmetro         | Local  | Tipo               | Obrigatório | Descrição                                                                                                                                                                                                     |
| ----------------- | ------ | ------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Idempotency-Key` | header | `string` (max 100) | Não         | Chave de idempotência de negócio. Reenviar a mesma chave retorna o `requestId` existente sem publicar novamente. Ver [Idempotência](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/idempotencia.md). |

### Corpo

| Campo                    | Tipo                                | Obrigatório | Descrição                                                                                                                                                                                                                                                                                                                                       |
| ------------------------ | ----------------------------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cpf`                    | `string` (11 dígitos, `^\d{11}$`)   | Sim         | CPF do trabalhador, 11 dígitos numéricos sem pontuação.                                                                                                                                                                                                                                                                                         |
| `contractNumber`         | `string` (1–8 dígitos, `^\d{1,8}$`) | Sim         | Número do contrato. Combinado com o `code` do originador, deriva o `reserveIdentifier` de 13 ou 14 caracteres devolvido no `202`. Como essa derivação é determinística, **reenviar o mesmo `contractNumber` para o mesmo originador colide com a reserva já criada** e a segunda averbação é descartada — use um número distinto por averbação. |
| `operationKind`          | `string` (enum)                     | Sim         | Tipo de operação de reserva: `FIDUCIARY_ASSIGNMENT` (cessão fiduciária) ou `FIDUCIARY_ALIENATION` (alienação fiduciária).                                                                                                                                                                                                                       |
| `periods`                | `array` (1–5 itens)                 | Sim         | Parcelas a averbar. Máx. 5; os anos podem ser quaisquer, não precisam ser consecutivos nem distintos; a primeira (menor data) deve ter `transferDate` estritamente no futuro.                                                                                                                                                                   |
| `periods[].transferDate` | `string` (`yyyy-MM-dd`, ISO-8601)   | Sim         | Data de transferência da parcela. Deve ser uma data válida no calendário.                                                                                                                                                                                                                                                                       |
| `periods[].amount`       | `number` (> 0)                      | Sim         | Valor da parcela em Reais (BRL).                                                                                                                                                                                                                                                                                                                |

## Response

| Campo               | Tipo                                                                      | Descrição                                                                                                                                                                                                                                                                                                                                             |
| ------------------- | ------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `requestId`         | `string` (uuid)                                                           | Identificador único da requisição admitida, gerado pela API. Use no polling em `GET /api/v1/fgts/operations/{requestId}`.                                                                                                                                                                                                                             |
| `status`            | `string`                                                                  | `QUEUED` — operação enfileirada para processamento assíncrono.                                                                                                                                                                                                                                                                                        |
| `reserveIdentifier` | `string` (13 ou 14 caracteres, `^GT[FD][0-9]{8}[0-9A-HJKMNP-TV-Z]{2,3}$`) | Identificador determinístico da reserva criada — o código do originador no final tem 2 ou 3 caracteres, daí o tamanho variável. É este o valor a informar em consultas, manutenção, cancelamento e [retentativa](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference/operacoes-fgts/submeter-operacoes/retentar-averbacao.md) da reserva. |

* **202 Accepted** — averbação admitida para processamento assíncrono. Quando concluída, o `result` do polling conterá um protocolo gerado pela Caixa.

## Exemplo

```http
POST /api/v1/fgts/endorsements HTTP/1.1
Host: ingress.gtfgts.staging.giro.tech
Authorization: Bearer {originatorToken}
Content-Type: application/json
Idempotency-Key: endorse-CTR-2024-00042

{
  "cpf": "12345678901",
  "contractNumber": "00000042",
  "operationKind": "FIDUCIARY_ASSIGNMENT",
  "periods": [
    { "transferDate": "2030-09-01", "amount": 1234.56 }
  ]
}
```

```json
{
  "requestId": "b2c3d4e5-58cc-4372-a567-0e02b2c3d479",
  "status": "QUEUED",
  "reserveIdentifier": "GTD00000042AB"
}
```

## Próximo passo

Acompanhe o resultado em [Consultar status da operação](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference/operacoes-fgts/acompanhar-resultado/consultar-status-operacao.md) usando o `requestId` retornado, ou aguarde o callback no webhook cadastrado.

## Erros

| Código | Situação                                                                                                                                                                                                                                                                              |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400    | Validação de payload (campo obrigatório ausente, CPF fora do padrão `^\d{11}$`, etc.) — `errorCode = VALIDATION_ERROR`                                                                                                                                                                |
| 401    | Token ausente, inválido ou expirado — `errorCode = UNAUTHORIZED`                                                                                                                                                                                                                      |
| 422    | `Idempotency-Key` já usada nesta rota com outro corpo — `errorCode = IDEMPOTENCY_KEY_PAYLOAD_MISMATCH`. Nada é enfileirado; para uma operação nova, use uma chave nova. Ver [Idempotência](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/idempotencia.md#payload-diferente) |
| 429    | Hard ceiling de rate limit de ingresso excedido — `errorCode = INGRESS_RATE_LIMIT_EXCEEDED` (header `Retry-After: 1`, sem `X-RateLimit-*`). Ver [Prioridades e rate limit](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/prioridades-e-rate-limit.md)                       |
| 503    | Indisponibilidade momentânea; nada foi registrado — `errorCode = SUBMISSION_TEMPORARILY_UNAVAILABLE` (header `Retry-After: 5`). Repita com o mesmo corpo e a mesma `Idempotency-Key`                                                                                                  |
| 422    | Originator sem código cadastrado; o `reserveIdentifier` não pode ser gerado — `errorCode = ORIGINATOR_CODE_NOT_ASSIGNED`. Acione a Giro                                                                                                                                               |
| 500    | Erro interno inesperado — `errorCode = INTERNAL_ERROR`                                                                                                                                                                                                                                |

Os erros seguem o formato `ProblemDetail` (RFC 7807), com o campo `errorCode`. Ver [Erros da API](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/erros.md).

Esses são os erros da **requisição**. O desfecho da operação chega depois, no `error.code` do polling e do webhook — ver [`error.code` de operação](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/erros.md#catalogo-operacao) e [Códigos da Caixa](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/erros.md#catalogo-caixa). Na averbação, os desfechos mais comuns são `ENDORSEMENT_DENIED` (com o código cru da Caixa em `originalErrors`), `OPERATION_NOT_YET_ALLOWED`, `ENDORSEMENT_ALREADY_SUBMITTED`, `DUPLICATE_RESERVE_IDENTIFIER`, `PROVIDER_UNCONFIRMED` e `TRANSIENT_PROVIDER_RETRY_EXHAUSTED` — este último depois da [retentativa automática](https://docs.giro.tech/desenvolvedores/api-gtfgts/guias/erros.md#retrying) de até 72 h.

## Submete averbação FGTS

> Admite uma operação de averbação FGTS de forma assíncrona com prioridade \`NORMAL\`. O resultado é entregue via webhook cadastrado ou via polling em \`GET /api/v1/fgts/operations/{requestId}\`.\
> O campo \`payload\` é específico da operação de averbação conforme contrato do provedor.\
> O header \`Idempotency-Key\` é aceito para deduplicação de negócio.\
> \*\*Reenvio da mesma averbação:\*\* na ausência de \`Idempotency-Key\`, a deduplicação usa o \`reserveIdentifier\` — determinístico em \`(contractNumber, originador)\`. Reenviar a mesma averbação devolve o \`requestId\` da submissão original, não um novo, e não reprocessa.

```json
{"openapi":"3.0.3","info":{"title":"gtfgts-ingress Public API","version":"0.0.1"},"tags":[{"name":"fgts-operations","description":"Submissão assíncrona de operações FGTS (balance-queries, endorsements, guarantee-maintenances, reserve-cancellations, reserve-value-queries, reserve-protocol-queries, protocol-status-queries), polling de status por `requestId` e cancelamento síncrono de operação. Todas protegidas por JWT do originator."}],"servers":[{"url":"https://ingress.gtfgts.staging.giro.tech","description":"Homologação (testes e validação da integração)"},{"url":"https://gtfgts.giro.tech","description":"Produção (operações reais)"},{"url":"http://localhost:8080","description":"Local (bootRun -Pprofiles=local)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT de originator fornecido pela GTLab no cadastro do originator. Identifica e autoriza o originator em todos os endpoints `/api/v1/**`.\nInclua no header: `Authorization: Bearer <token>`."}}},"paths":{"/api/v1/fgts/endorsements":{"post":{"operationId":"submitEndorsement","tags":["fgts-operations"],"summary":"Submete averbação FGTS","description":"Admite uma operação de averbação FGTS de forma assíncrona com prioridade `NORMAL`. O resultado é entregue via webhook cadastrado ou via polling em `GET /api/v1/fgts/operations/{requestId}`.\nO campo `payload` é específico da operação de averbação conforme contrato do provedor.\nO header `Idempotency-Key` é aceito para deduplicação de negócio.\n**Reenvio da mesma averbação:** na ausência de `Idempotency-Key`, a deduplicação usa o `reserveIdentifier` — determinístico em `(contractNumber, originador)`. Reenviar a mesma averbação devolve o `requestId` da submissão original, não um novo, e não reprocessa.","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Chave de idempotência de negócio. Reenviar a mesma chave retorna o `requestId` existente sem reprocessar. Omitido, o `reserveIdentifier` cumpre esse papel na averbação.","schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Corpo da requisição para submissão de averbação FGTS (prioridade NORMAL).","required":["cpf","contractNumber","operationKind","periods"],"properties":{"cpf":{"type":"string","pattern":"^\\d{11}$","minLength":11,"maxLength":11,"description":"CPF do trabalhador — 11 dígitos numéricos sem pontuação. Campo PII. Formato e dígitos verificadores (mód-11) validados na entrada; sequências de dígitos repetidos são rejeitadas com `400`."},"contractNumber":{"type":"string","pattern":"^\\d{1,8}$","minLength":1,"maxLength":8,"description":"Número do contrato — 1 a 8 dígitos decimais (zero-padded para 8 pelo gerador). Combinado com o `code` do originador para derivar o identificador de 13 caracteres (`GTD{contractNumber:8}{code:2}`)."},"operationKind":{"type":"string","enum":["FIDUCIARY_ASSIGNMENT","FIDUCIARY_ALIENATION"],"description":"Tipo de operação de reserva. `FIDUCIARY_ASSIGNMENT`: cessão fiduciária. `FIDUCIARY_ALIENATION`: alienação fiduciária."},"periods":{"type":"array","minItems":1,"maxItems":5,"items":{"type":"object","description":"Período individual de uma averbação (criação de reserva).","required":["transferDate","amount"],"properties":{"transferDate":{"type":"string","format":"date","description":"Data de transferência em formato ISO-8601 `yyyy-MM-dd` (ex.: `\"2030-09-01\"`). Deve ser uma data válida no calendário gregoriano."},"amount":{"type":"number","format":"double","minimum":0,"exclusiveMinimum":true,"description":"Valor monetário do período em Reais (BRL). Deve ser positivo."}}},"description":"Lista de parcelas a serem averbadas. Regras de validação: máximo de 5 parcelas; os anos podem ser quaisquer, não precisam ser consecutivos nem distintos; a primeira parcela (menor data) deve ter `transferDate` estritamente no futuro (hoje não conta como futuro)."}}}}}},"responses":{"202":{"description":"Averbação admitida para processamento assíncrono. O campo `reserveIdentifier` contém o identificador determinístico de 13 caracteres gerado (`GTD{contractNumber:8}{code:2}`). Quando concluída, o campo `result` do polling conterá um `ProtocolResult`.","content":{"application/json":{"schema":{"type":"object","description":"Confirmação de admissão assíncrona da operação FGTS (`202 Accepted`). O processamento ocorre em background; acompanhe pelo `requestId` via polling (`GET /api/v1/fgts/operations/{requestId}`) ou pelo webhook cadastrado.\n**Exceção para `balance-queries`:** quando o saldo já está disponível, a resposta é `200 OK` com `status: COMPLETED`, `source: CAIXA_CALL` e `result` com o saldo — não é necessário polling, e o webhook é enviado também. Caso contrário, retorna `202`.","required":["requestId","status"],"properties":{"requestId":{"type":"string","format":"uuid","description":"Identificador único (UUID) gerado pelo serviço para esta chamada. Em resposta `202` a requisição foi admitida no processamento assíncrono e este é o identificador de polling: use-o em `GET /api/v1/fgts/operations/{requestId}`. Em resposta `200` de `balance-queries` o resultado já vem inline em `result`, e a operação também é admitida com este `requestId`: é o mesmo do webhook e é consultável em `GET /api/v1/fgts/operations/{requestId}`. Só é preciso fazer polling quando o `status` for `QUEUED`."},"status":{"type":"string","enum":["QUEUED","COMPLETED"],"description":"Status da operação no momento da admissão. `QUEUED`: operação enfileirada para processamento assíncrono (resposta `202`). `COMPLETED`: resultado disponível inline no campo `result` — ocorre apenas quando o saldo de `balance-queries` já está disponível (resposta `200`)."},"source":{"type":"string","nullable":true,"enum":["CAIXA_CALL"],"description":"Origem do resultado. Presente apenas em resposta `200` de `balance-queries`. `CAIXA_CALL`: saldo apurado na Caixa. Nulo em respostas `202`."},"result":{"nullable":true,"description":"Resultado da operação. Presente apenas em resposta `200` de `balance-queries`. Nulo em respostas `202`.","oneOf":[{"type":"object","description":"Resultado de consulta de saldo (`BALANCE_QUERY`) com saldo disponível — saldo FGTS do trabalhador, com a lista de períodos e valores por competência.","required":["workerCpf","balanceDate"],"properties":{"workerCpf":{"type":"string","description":"CPF do trabalhador (11 dígitos, sem pontuação)."},"balanceDate":{"type":"string","format":"date","description":"Data de referência do saldo consultado (ISO-8601, ex. `2026-05-20`)."},"hasDisregardedBalance":{"type":"boolean","description":"Indica que o trabalhador possui valores de FGTS não considerados no saldo retornado, por não estarem disponíveis para uso como garantia. Pode vir ausente quando a Caixa não informa o campo."},"activeRequestCount":{"type":"integer","description":"Quantidade de pedidos de garantia ativos para o trabalhador na Caixa, considerando todas as instituições — não apenas as reservas deste originador. Reflete o momento da apuração do saldo, não o da requisição: o valor pode estar desatualizado."},"periods":{"type":"array","description":"Lista de períodos com valor disponível para averbação.","items":{"type":"object","description":"Período de competência com valor disponível para averbação.","required":["transferDate","amount"],"properties":{"transferDate":{"type":"string","format":"date","description":"Data de transferência (competência) do período (ISO-8601, ex. `2026-05-01`)."},"amount":{"type":"number","description":"Valor disponível para averbação neste período."}}}}}},{"type":"object","description":"Resultado de consulta de saldo (`BALANCE_QUERY`) sem saldo disponível para averbação.","required":["hasBalance"],"properties":{"hasBalance":{"type":"boolean","description":"Sempre `false` — indica ausência de saldo."}}}]},"reserveIdentifier":{"type":"string","nullable":true,"minLength":13,"maxLength":14,"pattern":"^GT[FD][0-9]{8}[0-9A-HJKMNP-TV-Z]{2,3}$","description":"Identificador determinístico de 13 ou 14 caracteres (`GTD{contractNumber:8}{code:2..3}`) gerado no momento da submissão de averbação — o código do originador tem 2 ou 3 caracteres. Presente apenas em respostas `202` de `POST /endorsements`. Nulo para todos os outros tipos de operação."}}}}}},"400":{"description":"Requisição inválida — falha de validação de Bean Validation (campos obrigatórios ausentes, formatos incorretos, CPF com dígitos errados, etc.). O campo `errors` contém um mapa `{ \"campo\": \"mensagem\" }` para cada campo inválido. O campo `title` é sempre `\"Bean validation error\"` e `detail` é sempre `\"One or more fields were invalid. See 'errors' for details.\"`.\nRejeições de regra de negócio também chegam como `400`, com `errorCode` próprio (ex.: `CONTRACT_INSTALLMENTS_MISMATCH`). Quando a rejeição aponta um campo do request, ela traz o mesmo `errors` e o mesmo `detail`; quando não há campo associado, `errors` é omitido e `detail` é o reason phrase do status.","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro estruturado segundo RFC 7807 — Problem Details for HTTP APIs. Campos adicionais `errorCode` (código canônico GTLab estável) e `timestamp` (instante do erro no servidor) são extensões proprietárias. O campo `errors` (mapa campo→mensagem) é incluído nos erros que apontam para um campo do request: validação de Bean Validation (`errorCode: VALIDATION_ERROR`, HTTP 400) e rejeições de regra de negócio que identificam o campo culpado (ex.: `CONTRACT_INSTALLMENTS_MISMATCH`). Nos erros que não têm campo associado (`401`, `403`, `404`, `429`, `500`, `503`, e rejeições de negócio sem campo) o campo `errors` está ausente.","properties":{"type":{"type":"string","format":"uri","description":"URI de referência do tipo de problema."},"title":{"type":"string","description":"Título legível do tipo de problema."},"status":{"type":"integer","format":"int32","description":"HTTP status code do problema."},"detail":{"type":"string","description":"Descrição legível específica desta ocorrência do problema."},"instance":{"type":"string","description":"URI reference (relativa ou absoluta) que identifica esta ocorrência específica do problema. Geralmente o path do endpoint que gerou o erro."},"errorCode":{"type":"string","description":"Código de erro canônico GTLab estável para uso programático."},"timestamp":{"type":"string","format":"date-time","description":"Instante em que o erro ocorreu no servidor (ISO-8601 UTC)."},"errors":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Mapa de erros no formato `{ \"campo\": \"mensagem\" }`, onde cada chave nomeia um campo do **request enviado por você**. Presente quando `errorCode` é `VALIDATION_ERROR` (falha de Bean Validation — `@NotBlank`, `@NotNull`, `@Size`, `@Pattern`, etc.) e também em rejeições de regra de negócio que conseguem apontar o campo culpado, como `CONTRACT_INSTALLMENTS_MISMATCH`. Quando presente, `detail` é `\"One or more fields were invalid. See 'errors' for details.\"`. Ausente em erros sem campo associado (`401`, `403`, `404`, `429`, `500`, `503`) e em rejeições de negócio que não se referem a um campo do request."}}}}}},"401":{"description":"Não autenticado — JWT ausente, inválido ou expirado. Autentique-se e inclua o token no header `Authorization: Bearer <token>`.","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro estruturado segundo RFC 7807 — Problem Details for HTTP APIs. Campos adicionais `errorCode` (código canônico GTLab estável) e `timestamp` (instante do erro no servidor) são extensões proprietárias. O campo `errors` (mapa campo→mensagem) é incluído nos erros que apontam para um campo do request: validação de Bean Validation (`errorCode: VALIDATION_ERROR`, HTTP 400) e rejeições de regra de negócio que identificam o campo culpado (ex.: `CONTRACT_INSTALLMENTS_MISMATCH`). Nos erros que não têm campo associado (`401`, `403`, `404`, `429`, `500`, `503`, e rejeições de negócio sem campo) o campo `errors` está ausente.","properties":{"type":{"type":"string","format":"uri","description":"URI de referência do tipo de problema."},"title":{"type":"string","description":"Título legível do tipo de problema."},"status":{"type":"integer","format":"int32","description":"HTTP status code do problema."},"detail":{"type":"string","description":"Descrição legível específica desta ocorrência do problema."},"instance":{"type":"string","description":"URI reference (relativa ou absoluta) que identifica esta ocorrência específica do problema. Geralmente o path do endpoint que gerou o erro."},"errorCode":{"type":"string","description":"Código de erro canônico GTLab estável para uso programático."},"timestamp":{"type":"string","format":"date-time","description":"Instante em que o erro ocorreu no servidor (ISO-8601 UTC)."},"errors":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Mapa de erros no formato `{ \"campo\": \"mensagem\" }`, onde cada chave nomeia um campo do **request enviado por você**. Presente quando `errorCode` é `VALIDATION_ERROR` (falha de Bean Validation — `@NotBlank`, `@NotNull`, `@Size`, `@Pattern`, etc.) e também em rejeições de regra de negócio que conseguem apontar o campo culpado, como `CONTRACT_INSTALLMENTS_MISMATCH`. Quando presente, `detail` é `\"One or more fields were invalid. See 'errors' for details.\"`. Ausente em erros sem campo associado (`401`, `403`, `404`, `429`, `500`, `503`) e em rejeições de negócio que não se referem a um campo do request."}}}}}},"429":{"description":"Teto de vazão das submissões FGTS excedido (`INGRESS_RATE_LIMIT_EXCEEDED`) — a requisição foi rejeitada e nenhum `requestId` foi gerado. Aguarde `Retry-After` (1 segundo) e reduza a taxa. Esta resposta não traz os headers de janela. Abaixo do teto e acima da cota, a requisição é admitida com prioridade `DEFERRED` (`202`).","headers":{"Retry-After":{"description":"Segundos até a próxima janela disponível.","schema":{"type":"integer","format":"int64"}}},"content":{"application/problem+json":{"schema":{"type":"object","description":"Erro estruturado segundo RFC 7807 — Problem Details for HTTP APIs. Campos adicionais `errorCode` (código canônico GTLab estável) e `timestamp` (instante do erro no servidor) são extensões proprietárias. O campo `errors` (mapa campo→mensagem) é incluído nos erros que apontam para um campo do request: validação de Bean Validation (`errorCode: VALIDATION_ERROR`, HTTP 400) e rejeições de regra de negócio que identificam o campo culpado (ex.: `CONTRACT_INSTALLMENTS_MISMATCH`). Nos erros que não têm campo associado (`401`, `403`, `404`, `429`, `500`, `503`, e rejeições de negócio sem campo) o campo `errors` está ausente.","properties":{"type":{"type":"string","format":"uri","description":"URI de referência do tipo de problema."},"title":{"type":"string","description":"Título legível do tipo de problema."},"status":{"type":"integer","format":"int32","description":"HTTP status code do problema."},"detail":{"type":"string","description":"Descrição legível específica desta ocorrência do problema."},"instance":{"type":"string","description":"URI reference (relativa ou absoluta) que identifica esta ocorrência específica do problema. Geralmente o path do endpoint que gerou o erro."},"errorCode":{"type":"string","description":"Código de erro canônico GTLab estável para uso programático."},"timestamp":{"type":"string","format":"date-time","description":"Instante em que o erro ocorreu no servidor (ISO-8601 UTC)."},"errors":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Mapa de erros no formato `{ \"campo\": \"mensagem\" }`, onde cada chave nomeia um campo do **request enviado por você**. Presente quando `errorCode` é `VALIDATION_ERROR` (falha de Bean Validation — `@NotBlank`, `@NotNull`, `@Size`, `@Pattern`, etc.) e também em rejeições de regra de negócio que conseguem apontar o campo culpado, como `CONTRACT_INSTALLMENTS_MISMATCH`. Quando presente, `detail` é `\"One or more fields were invalid. See 'errors' for details.\"`. Ausente em erros sem campo associado (`401`, `403`, `404`, `429`, `500`, `503`) e em rejeições de negócio que não se referem a um campo do request."}}}}}},"500":{"description":"Erro interno inesperado no servidor.","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro estruturado segundo RFC 7807 — Problem Details for HTTP APIs. Campos adicionais `errorCode` (código canônico GTLab estável) e `timestamp` (instante do erro no servidor) são extensões proprietárias. O campo `errors` (mapa campo→mensagem) é incluído nos erros que apontam para um campo do request: validação de Bean Validation (`errorCode: VALIDATION_ERROR`, HTTP 400) e rejeições de regra de negócio que identificam o campo culpado (ex.: `CONTRACT_INSTALLMENTS_MISMATCH`). Nos erros que não têm campo associado (`401`, `403`, `404`, `429`, `500`, `503`, e rejeições de negócio sem campo) o campo `errors` está ausente.","properties":{"type":{"type":"string","format":"uri","description":"URI de referência do tipo de problema."},"title":{"type":"string","description":"Título legível do tipo de problema."},"status":{"type":"integer","format":"int32","description":"HTTP status code do problema."},"detail":{"type":"string","description":"Descrição legível específica desta ocorrência do problema."},"instance":{"type":"string","description":"URI reference (relativa ou absoluta) que identifica esta ocorrência específica do problema. Geralmente o path do endpoint que gerou o erro."},"errorCode":{"type":"string","description":"Código de erro canônico GTLab estável para uso programático."},"timestamp":{"type":"string","format":"date-time","description":"Instante em que o erro ocorreu no servidor (ISO-8601 UTC)."},"errors":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Mapa de erros no formato `{ \"campo\": \"mensagem\" }`, onde cada chave nomeia um campo do **request enviado por você**. Presente quando `errorCode` é `VALIDATION_ERROR` (falha de Bean Validation — `@NotBlank`, `@NotNull`, `@Size`, `@Pattern`, etc.) e também em rejeições de regra de negócio que conseguem apontar o campo culpado, como `CONTRACT_INSTALLMENTS_MISMATCH`. Quando presente, `detail` é `\"One or more fields were invalid. See 'errors' for details.\"`. Ausente em erros sem campo associado (`401`, `403`, `404`, `429`, `500`, `503`) e em rejeições de negócio que não se referem a um campo do request."}}}}}},"503":{"description":"Serviço temporariamente indisponível. Aguarde `Retry-After` segundos e tente novamente.","headers":{"Retry-After":{"description":"Segundos recomendados até a próxima tentativa.","schema":{"type":"integer","format":"int64"}}},"content":{"application/problem+json":{"schema":{"type":"object","description":"Erro estruturado segundo RFC 7807 — Problem Details for HTTP APIs. Campos adicionais `errorCode` (código canônico GTLab estável) e `timestamp` (instante do erro no servidor) são extensões proprietárias. O campo `errors` (mapa campo→mensagem) é incluído nos erros que apontam para um campo do request: validação de Bean Validation (`errorCode: VALIDATION_ERROR`, HTTP 400) e rejeições de regra de negócio que identificam o campo culpado (ex.: `CONTRACT_INSTALLMENTS_MISMATCH`). Nos erros que não têm campo associado (`401`, `403`, `404`, `429`, `500`, `503`, e rejeições de negócio sem campo) o campo `errors` está ausente.","properties":{"type":{"type":"string","format":"uri","description":"URI de referência do tipo de problema."},"title":{"type":"string","description":"Título legível do tipo de problema."},"status":{"type":"integer","format":"int32","description":"HTTP status code do problema."},"detail":{"type":"string","description":"Descrição legível específica desta ocorrência do problema."},"instance":{"type":"string","description":"URI reference (relativa ou absoluta) que identifica esta ocorrência específica do problema. Geralmente o path do endpoint que gerou o erro."},"errorCode":{"type":"string","description":"Código de erro canônico GTLab estável para uso programático."},"timestamp":{"type":"string","format":"date-time","description":"Instante em que o erro ocorreu no servidor (ISO-8601 UTC)."},"errors":{"type":"object","nullable":true,"additionalProperties":{"type":"string"},"description":"Mapa de erros no formato `{ \"campo\": \"mensagem\" }`, onde cada chave nomeia um campo do **request enviado por você**. Presente quando `errorCode` é `VALIDATION_ERROR` (falha de Bean Validation — `@NotBlank`, `@NotNull`, `@Size`, `@Pattern`, etc.) e também em rejeições de regra de negócio que conseguem apontar o campo culpado, como `CONTRACT_INSTALLMENTS_MISMATCH`. Quando presente, `detail` é `\"One or more fields were invalid. See 'errors' for details.\"`. Ausente em erros sem campo associado (`401`, `403`, `404`, `429`, `500`, `503`) e em rejeições de negócio que não se referem a um campo do request."}}}}}}}}}}}
```

## Resultado no webhook

Concluída a averbação, a Giro.Tech envia ao webhook cadastrado um envelope `{ source, eventType, data }`. Para esta operação o `source` é **`ENDORSEMENT`** e os `eventType` possíveis são:

| `eventType`                      | Quando                                    | `data`                                                                                                                                                                                                                                                                                                                          |
| -------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ENDORSEMENT_COMPLETED`          | averbação concluída com sucesso           | `result` = `ProtocolResult` (`protocolNumber`, `protocolStatus`, `detail`); `protocolNumber` também no nível superior                                                                                                                                                                                                           |
| `ENDORSEMENT_FAILED`             | averbação negada/com erro                 | `error` (`OperationError`; `originalErrors[]` quando a Caixa retornou erro). Erro **transitório** só chega aqui depois de até **72 h** de retentativa automática — ver [Retentativa](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference/operacoes-fgts/submeter-operacoes/retentar-averbacao.md#antes-de-retentar) |
| `ENDORSEMENT_NEEDS_VERIFICATION` | expirou sem desfecho (`status = EXPIRED`) | sem `result`; `error.code = EXPIRED_TTL` — verifique por polling antes de assumir o desfecho. Confirmada a falta de desfecho, a reserva é [retentável](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference/operacoes-fgts/submeter-operacoes/retentar-averbacao.md)                                                 |

Nos três eventos, `data.contractNumber` acompanha o desfecho, ecoado do `contractNumber` que você enviou na submissão — que é obrigatório nesta operação, então o campo está sempre presente.

### ENDORSEMENT\_COMPLETED

Averbação concluída, com `result` e os identificadores `contractNumber`/`reserveIdentifier`/`protocolNumber` presentes no nível superior do `data`.

```json
{
  "source": "ENDORSEMENT",
  "eventType": "ENDORSEMENT_COMPLETED",
  "data": {
    "requestId": "b2c3d479-4372-a567-58cc-f47ac10b0e02",
    "contractNumber": "00000042",
    "reserveIdentifier": "orig-123:res-1",
    "protocolNumber": "123456789",
    "status": "COMPLETED",
    "source": "CAIXA_CALL",
    "result": {
      "protocolNumber": "123456789",
      "protocolStatus": "ENDORSED",
      "detail": { "href": "/fgts/v1/protocolos/123456789", "rel": "self" }
    }
  }
}
```

### ENDORSEMENT\_FAILED

Averbação negada, com `error` (`OperationError`) e `originalErrors` — a Caixa foi chamada e retornou erro.

```json
{
  "source": "ENDORSEMENT",
  "eventType": "ENDORSEMENT_FAILED",
  "data": {
    "requestId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "reserveIdentifier": "orig-123:res-1",
    "status": "FAILED",
    "source": "CAIXA_CALL",
    "error": {
      "code": "ENDORSEMENT_DENIED",
      "message": "Endorsement denied by Caixa",
      "originalErrors": [
        {
          "provider": "CAIXA",
          "code": "14",
          "description": "Averbacao negada — saldo insuficiente",
          "httpStatus": 422,
          "requestIdentifier": "orig-123:res-1",
          "occurredAt": "2026-06-15T10:00:03Z"
        }
      ]
    }
  }
}
```

### ENDORSEMENT\_NEEDS\_VERIFICATION

Averbação **expirada** (`status = EXPIRED`): atingiu o tempo limite interno de 24 h sem chegar a um desfecho. A expiração acontece **na fila da Giro**, antes do despacho — não é tempo esgotado esperando resposta da Caixa. Não há `result`; o `error` traz apenas `code = EXPIRED_TTL`, que marca a expiração e **não** é veredito da Caixa. **Verifique** por polling em [`GET /api/v1/fgts/operations/{requestId}`](https://docs.giro.tech/desenvolvedores/api-gtfgts/api-reference/operacoes-fgts/acompanhar-resultado/consultar-status-operacao.md) antes de assumir qualquer resultado.

```json
{
  "source": "ENDORSEMENT",
  "eventType": "ENDORSEMENT_NEEDS_VERIFICATION",
  "data": {
    "requestId": "d1e2f3a4-b5c6-7890-abcd-ef1234567890",
    "reserveIdentifier": "orig-123:res-2",
    "status": "EXPIRED",
    "source": "NA",
    "error": {
      "code": "EXPIRED_TTL"
    }
  }
}
```

Catálogo completo de eventos e payloads em [Eventos](https://docs.giro.tech/desenvolvedores/api-gtfgts/webhooks/eventos.md) e [Payloads](https://docs.giro.tech/desenvolvedores/api-gtfgts/webhooks/payloads.md).

{% embed url="<https://giro.tech/central-de-atendimento/>" %}
