> 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-gtpayroll/api-reference/autorizacao/consultar-status-autorizacao.md).

# Consultar Status da Autorização

Retorna o status da autorização Dataprev de um trabalhador. Se não usar o webhook `AUTHORIZATION_COMPLETED`, consulte a cada **10 a 30 segundos** até `AUTHORIZED`.

## Request

`GET /api/v1/originator/employees/{publicId}/authorization/status`

### Parâmetros

| Parâmetro  | Local | Tipo     | Obrigatório | Descrição                                         |
| ---------- | ----- | -------- | ----------- | ------------------------------------------------- |
| `publicId` | path  | `string` | Sim         | Identificador público do employee (16 caracteres) |

## Response

| Campo               | Tipo                 | Descrição                                                                                                                                                                                                                                                  |
| ------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `status`            | `string`             | Status da autorização: `NOT_STARTED` (processo não iniciado), `PENDING_SIGNATURE` (aguardando assinatura do termo), `PENDING_SUBMISSION` (aguardando envio ao Dataprev), `AUTHORIZED` (autorização concluída) ou `EXPIRED` (prazo de assinatura expirado). |
| `message`           | `string`             | Mensagem descritiva do status atual.                                                                                                                                                                                                                       |
| `signUrl`           | `string`             | **Descontinuado.** Vem `null` nos caminhos atuais.                                                                                                                                                                                                         |
| `nsu`               | `string`             | NSU do documento, quando aplicável.                                                                                                                                                                                                                        |
| `expiresAt`         | `string` (date-time) | Data/hora de expiração do prazo de assinatura.                                                                                                                                                                                                             |
| `daysRemaining`     | `integer`            | Dias restantes até a expiração.                                                                                                                                                                                                                            |
| `signatureStrategy` | `string`             | Estratégia de assinatura da autorização do originador: `ORIGINATOR_MANAGED` nos caminhos atuais; `GIRO` só em originadores legados, do fluxo descontinuado em que a Giro coletava a assinatura.                                                            |

## Exemplo

```http
GET /api/v1/originator/employees/Kj8mP2xQ9nR4sT6v/authorization/status
Authorization: Bearer {originatorToken}
```

Resposta `200`:

```json
{
  "status": "PENDING_SUBMISSION",
  "message": "Termo assinado. Aguardando envio ao Dataprev.",
  "nsu": "20250115000001",
  "expiresAt": "2025-01-22T23:59:59Z",
  "daysRemaining": 7,
  "signatureStrategy": "ORIGINATOR_MANAGED"
}
```

Com `AUTHORIZED`, siga para [Consultar Margem](https://docs.giro.tech/desenvolvedores/api-gtpayroll/api-reference/margem/consultar-margem.md).

## Erros

| Código | `errorCode` | Situação                                                                                                                        |
| ------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------- |
| 404    | —           | `Employee não encontrado` — inexistente ou de outro originador                                                                  |
| —      | —           | Depois de um `AUTHORIZATION_FAILED` de employee nunca autorizado, o status volta a `NOT_STARTED`: a falha só aparece no webhook |

Erros comuns a todos os endpoints — `401`, `403` de token, `409` de `Idempotency-Key` em processamento, `500` e `503` — e o formato `ProblemDetail` estão em [Erros da API](https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/erros.md).

## Status de Autorização

> Consulta status de autorização Dataprev de um employee

```json
{"openapi":"3.0.0","info":{"title":"GT Payroll Originator API","version":"1.1.0"},"tags":[{"name":"Authorization","description":"Autorização Dataprev para consulta de dados"}],"servers":[{"url":"https://ingress.gtpayroll.staging.giro.tech","description":"Ambiente de Staging"},{"url":"https://ingress.gtpayroll.giro.tech","description":"Ambiente de Produção"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token fornecido pelo administrador"}}},"paths":{"/api/v1/originator/employees/{publicId}/authorization/status":{"get":{"summary":"Status de Autorização","description":"Consulta status de autorização Dataprev de um employee","tags":["Authorization"],"parameters":[{"name":"publicId","in":"path","required":true,"description":"Identificador público do employee (16 caracteres)","schema":{"type":"string"}}],"responses":{"200":{"description":"Status retornado com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["NOT_STARTED","PENDING_SIGNATURE","PENDING_SUBMISSION","AUTHORIZED","EXPIRED"],"description":"Status da autorização Dataprev.\n| Valor | Significado |\n|-------|-------------|\n| NOT_STARTED | Processo não iniciado |\n| PENDING_SIGNATURE | Aguardando assinatura do termo |\n| PENDING_SUBMISSION | Aguardando envio ao Dataprev |\n| AUTHORIZED | Autorização concluída (termo assinado) |\n| EXPIRED | Prazo de assinatura expirado |\n"},"message":{"type":"string"},"signUrl":{"type":"string","deprecated":true,"description":"**Descontinuado.** Pertencia ao fluxo em que a Giro coletava a assinatura do termo.\nNos fluxos atuais a assinatura é sempre coletada pelo originador e o campo vem `null`.\n"},"nsu":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"daysRemaining":{"type":"integer"},"signatureStrategy":{"type":"string","enum":["GIRO","ORIGINATOR_MANAGED"],"description":"Estratégia de assinatura da autorização configurada para o originator.\n`ORIGINATOR_MANAGED` é o valor dos fluxos atuais — o originador coleta a assinatura\n(termo em PDF) ou o opt-in (trilha) e envia o lastro à Giro. `GIRO` só aparece em\noriginadores legados, do fluxo **descontinuado** em que a plataforma coletava a assinatura.\n"}}}}}},"401":{"description":"Não autenticado","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro de autenticação (HTTP 401). Token ausente, com prefixo diferente de `Bearer `, expirado, revogado ou inválido.","required":["type","title","status"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"403":{"description":"Permissão insuficiente","content":{"application/problem+json":{"schema":{"type":"object","description":"Erro de autorização (HTTP 403). Token válido de outro perfil, sem permissão de originador.\nRecusas de permissão por regra de negócio (ex.: `ORIGINATOR_OPT_IN_NOT_ENABLED`) usam\n`#business-rule-violation` com `properties.errorCode`.\n","required":["type","title","status"],"properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}},"404":{"description":"Employee não encontrado ou de outro originador.","content":{"application/problem+json":{"schema":{"type":"object","description":"Resposta de erro no formato RFC 7807 (Problem Details). Os campos extras **não** vêm na raiz:\nficam dentro de `properties` (`message`, `errorCode`, `errors`, `retryAfter`…).\n\nIdentifique o erro por `status` + `properties.errorCode`. O `type` agrupa famílias e sozinho não\nidentifica o erro: `#business-rule-violation` aparece com 400, 403, 404, 409, 413, 422 e 503.\nCatálogo completo em https://docs.giro.tech/desenvolvedores/api-gtpayroll/guias/erros.\n","required":["type","title","status"],"properties":{"type":{"type":"string","description":"URL do guia de erros com o fragmento da família: `validation-error`, `not-authenticated`,\n`forbidden`, `resource-not-found`, `conflict`, `business-rule-violation`,\n`dataprev-suspension-window`, `rate-limit-exceeded`, `internal-error`, `upstream-error`,\n`service-unavailable`. Corpo ilegível, parâmetro de tipo errado, rota inexistente, `405` e\n`415` vêm como `about:blank`, sem `properties`.\n"},"title":{"type":"string","description":"Resumo curto. Na maioria dos casos é a frase padrão do status HTTP."},"status":{"type":"integer","description":"Código HTTP do erro"},"detail":{"type":"string","description":"Mensagem legível desta ocorrência. Pode mudar de texto; use `properties.errorCode` para automação."},"instance":{"type":"string","description":"Path da requisição que falhou"},"properties":{"type":"object","nullable":true,"description":"Extensões do ProblemDetail. Ausente (`null`) nas respostas `about:blank`.","additionalProperties":true,"properties":{"message":{"type":"string","description":"Repete o `detail`."},"errorCode":{"type":"string","description":"Código estável da regra violada. Opcional: só parte dos erros de regra de negócio tem.\nLista por status no guia de erros.\n"},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"(Apenas 400 `validation-error`) Mapa campo → mensagem."},"retryAfter":{"type":"integer","description":"(429 e 503) Segundos a aguardar antes de nova requisição."},"limit":{"type":"integer","description":"(Apenas 429) Limite de requisições da janela."},"resetAt":{"type":"integer","format":"int64","description":"(Apenas 429) Fim da janela, em epoch **milissegundos**."}}}}}}}}}}}}}
```

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