Consultar autorizações de saldo FGTS

GET/v1/fgts/autorizacoes

🔒 Requer Bearer token

Escopo fgts:read. Lista as autorizações de consulta de saldo FGTS do CPF. A janela de datas é resolvida no backend. Uma autorização ativo: true é a pré-condição para consultar saldo / saldo retido — este endpoint não devolve token de consulta (o token do Dataprev é resolvido pelo servidor na consulta de saldo, a partir da autorização de margem do CPF). Sem registros retorna { "autorizacoes": [] }.

Parâmetros

cpfstringqueryobrigatório

CPF do trabalhador (11 dígitos, sem máscara)

padrão: ^\d{11}$

ativosbooleanqueryopcional

Filtra apenas autorizações ativas. Por padrão (`true`) retorna só as ativas.

Respostas

Corpo da resposta 200

autorizacoesarray<object>obrigatório

cpf_trabalhadorstringobrigatório

codigo_instituicao_financeiraintegerobrigatório

data_hora_inclusao_autorizacaostring<date-time>obrigatório

data_validade_autorizacaostring<date>obrigatório

ativobooleanobrigatório

data_hora_exclusao_autorizacaostring<date-time>obrigatórionullable

Request

curl -X GET 'https://econsignado-api.socinal.com.br/v1/fgts/autorizacoes?cpf=valor&ativos=valor' \
  -H 'Authorization: Bearer SEU_TOKEN'

Response

{
  "autorizacoes": [
    {
      "cpf_trabalhador": "12345678901",
      "codigo_instituicao_financeira": 425,
      "data_hora_inclusao_autorizacao": "2025-06-01T13:30:00.000Z",
      "data_validade_autorizacao": "2030-01-01",
      "ativo": true,
      "data_hora_exclusao_autorizacao": null
    }
  ]
}