Consultar saldo FGTS retido

GET/v1/fgts/saldo-retido

🔒 Requer Bearer token

Escopo fgts:read. Retorna o saldo/multa bloqueados (informativo — não desconta do valor da garantia). Mesmos parâmetros e pré-condições do saldo (tokenAutorizacao opcional, resolvido pelo servidor) + contrato opcional. Sem registro retorna { "saldo_retido": null }.

Parâmetros

cpfstringqueryobrigatório

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

padrão: ^\d{11}$

token_autorizacaostringqueryopcional

Token de autorização de consulta Dataprev. **Opcional** — quando omitido, o servidor usa o token da autorização de margem vigente do CPF (de `POST /v1/margem/autorizacao`). Informe apenas se você já possui um token próprio.

matriculastringqueryobrigatório

Matrícula do trabalhador no empregador

codigo_inscricao_empregadornumberqueryobrigatório

Tipo de inscrição do empregador. `1` = CNPJ, `2` = CPF.

numero_inscricao_empregadorstringqueryobrigatório

Número da inscrição do empregador, exatamente como veio em `GET /v1/margem/vinculos`. É **string**: o CNPJ pode ser alfanumérico (IN RFB 2.229/2024, ex.: `R7ZW4H8H000140`) e zeros à esquerda são significativos. Máscara (`.`, `/`, `-`) é aceita e removida.

máx. 30 car. · padrão: ^[A-Z0-9]{1,30}$

contratostringqueryopcional

Identificador do contrato para consulta de bloqueio. Omitido usa o placeholder padrão.

Respostas

Corpo da resposta 200

saldo_retidoobjectobrigatórionullable

data_hora_consultastring<date-time>obrigatório

status_pedido_bloqueioobjectobrigatório

codigointegerobrigatório

descricaostringobrigatório

valor_bloqueio_saldo_disponivel_solicitadonumberobrigatório

valor_bloqueio_multa_rescisoria_solicitadonumberobrigatório

valor_saldo_disponivel_bloqueado_consignadonumberobrigatório

valor_multa_rescisoria_bloqueada_consignadonumberobrigatório

url_consulta_repassestring<uri>obrigatórionullable

Request

curl -X GET 'https://econsignado-api.socinal.com.br/v1/fgts/saldo-retido?cpf=valor&token_autorizacao=valor&matricula=valor&codigo_inscricao_empregador=valor&numero_inscricao_empregador=valor&contrato=valor' \
  -H 'Authorization: Bearer SEU_TOKEN'

Response

{
  "saldo_retido": {
    "data_hora_consulta": "2025-07-03T17:15:00.000Z",
    "status_pedido_bloqueio": {
      "codigo": 1,
      "descricao": "Bloqueio ativo"
    },
    "valor_bloqueio_saldo_disponivel_solicitado": 1200.5,
    "valor_bloqueio_multa_rescisoria_solicitado": 250,
    "valor_saldo_disponivel_bloqueado_consignado": 1200.5,
    "valor_multa_rescisoria_bloqueada_consignado": 250,
    "url_consulta_repasse": null
  }
}