Consulta de Saldo FGTS & Multa Rescisória FGTS

Consulta de valores disponíveis

A consulta de dados do saldo FGTS do tomador de crédito, irá possibilitar que o originador verifique qual o valor de garantia irá atrelar a averbação.

Antes de realizar esta consulta é necessário que:

A Celcoin seja Autorizada para Consultar Informações do FGTS. Esta autorização é feita no app CTPS pelo trabalhador. Esta autorização tem uma validade de 30 dias corridos e pode ser excluída a qualquer momento pelo trabalhador.
Seja feita a Autorização para Consulta aos Dados do Vínculo Empregatício e Saldo FGTS

GET: https://platform.flowfinance.com.br/banking/originator/guarantee/{productId}/get-balance-fgts

Parâmetros

Campo	Descrição	Tipo
product_id	id do produto	UUID
balance_check_id	id da consulta de vínculo empregatício	UUID
employer_code	Código de inscrição do empregador	string
employer_document	Número de inscrição do empregador	string
employee_code	Matrícula do trabalhador	string
document	CPF do tomador	string

Importante
O envio do campo balance_check_id torna não obrigatório o envio dos campos employer_code, employer_document, employee_code e document.

{
    "id": "1d9cccdb-6dce-4699-8263-cae9d735bb8a",
    "consult_date_time": "2026-04-08T15:30:25",
    "document": "68591203712",
    "available_fgts_guarantee_balance": 3500,
    "severance_fine_fgts_guarantee": 4680.3
}

Parâmetros

Campo	Descrição	Tipo
id	Identificador da consulta FGTS	UUID
consult_date_time	Data e hora da consulta	string ISO-8601
document	CPF do tomador	string
available_fgts_guarantee_balance	Saldo FGTS disponível	number
severance_fine_fgts_guarantee	Multa Rescisória associada ao FGTS	number

Resposta Assíncrona

A Dataprev possui uma limitação de 25 requisições por segundo. Caso, no momento da requisição, a Dataprev retorne que o limite daquele segundo foi atingido, nosso sistema responderá a consulta de margem de forma assíncrona.

{
    "id": "c5171775-b0a6-44fe-9d8e-60c1e243da46",
    "consult_date_time": null,
    "document": null,
    "available_fgts_guarantee_balance": null,
    "severance_fine_fgts_guarantee": null,
    "message": "Request accepted for asynchronous processing"
}

Isso indica que a solicitação foi aceita e será processada posteriormente.

Notificação via Webhook
Quando a consulta for concluída, o resultado será enviado ao originador por meio de um webhook com o evento GuaranteeBalanceUpdate.

{
  "event": "GUARANTEE_BALANCE_FGTS_UPDATE",
  "payload": {
    "id": "e746ba58-8cfe-48e0-872a-a4109baba935",
    "consult_date_time": "2026-04-08T15:30:25",
    "document": "99976866836",
    "available_fgts_guarantee_balance": 3500.00,
    "severance_fine_fgts_guarantee": 4680.30,
    "status": "SUCCESS"
  }
}

Atenção: o campo payload é entregue como uma string JSON serializada. É necessário fazer JSON.parse(event.payload) antes de acessar os campos internos.

Campo	Descrição	Tipo
event	Identificador do tipo de evento disparado	string
payload	JSON serializado como string contendo os dados do evento. Deve ser parseado separadamente.	`string` (JSON serializado)