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

maximumHiringAmount
number<double>

Saldo liberado para utilização do cliente

fgtsBalance
number<double>
code
string | null
customerName
string | null