Pular para o conteúdo principal
cURL
Por meio deste endpoint o parceiro executa a simulação e busca de dados referente aos valores de FGTS disponíveis para trabalhador. Após o retorno dos valores, pode realizar empréstimos com garantia do Saque Aniversário, onde posteriormente serão inclusos em uma proposta. Esta ação antecede a inclusão e efetivação da proposta no sistema. Regras:
  • Caso seja informado o campo “Saldo”, não utilizamos o saldo verdadeiro do cliente na Caixa Econômica Federal e o cálculo será com base nos valores da nossa calculadora.
  • Caso o mês de aniversário esteja incorreto, o sistema retorna um erro no momento da simulação.
  • Em caso de preenchimento do campo CPF, a consulta é realizada na Caixa Econômica Federal
Quando o valor do campo ConsultaCache for false, a requisição consultará o saldo do FGTS atualizado diretamente na Caixa Econômica Federal (CEF); quando for true, o saldo será obtido do cache da BMP. Este campo não é obrigatório, caso não seja informado, o sistema assume o valor true como padrão.

Mensagens de erro

A tabela abaixo representa as mensagens de erro que podem ser retornadas ao tentar realizar uma requisição.

Autorizações

Authorization
string
header
obrigatório

Informe o token

Cabeçalhos

IdempotencyKey
string
obrigatório

Corpo

dto
object
obrigatório

Resposta

OK

Msg
string | null
HasError
boolean
Messages
object[] | null
IdentificadorConsulta
string<uuid> | null
CodigoBatch
string<uuid> | null
VlrDispSaque
number<double> | null
PeriodoMin
integer<int32> | null
PeriodoMax
integer<int32> | null
Simulacao
object
Consulta
object
Credencial
string | null