POST
Consultar saldo total disponível para utilização
Consulta o saldo FGTS disponível do cliente para antecipação, passo inicial do FGTS, antes de simular.
Autentique-se antes (Autenticação).

Body

Input com os dados do cliente para consulta de saldo

Representa os dados de entrada para a consulta de saldo disponível do FGTS em serviços externos.

document
string | null

CPF ou CNPJ do cliente.

type
integer<int32>

Tipo de pessoa. 0 = Pessoa Jurídica (PJ) 1 = Pessoa Física (PF)

phoneNumber
string | null

Número de telefone do cliente.

Response

OK

Saldo disponível de FGTS do cliente para contratação, para a API de integração.

maximumHiringAmount
number<double>

Saldo liberado para utilização do cliente

fgtsBalance
number<double>

Saldo total de FGTS do cliente consultado junto ao parceiro.

code
string | null

Código público da operação criada para a consulta de saldo.

customerName
string | null

Nome do cliente.