Como citado na introdução, a primeira parte da integração com o Banco Semear, e consequentemente criação da operação, consiste na consulta do saldo disponível do trabalhador. Isso permite que o cliente visualize a quantia que será disponibilizada para recebimento, em cada ano, pelo saque-aniversário FGTS.
Rota: /proposals/consulta-cpf (Post) #
Descrição: #
Realiza o pedido de consulta de saldo FGTS à CAIXA através do CPF do trabalhador.
Pedido de consulta #
- endpoint: /proposals/consulta-cpf
- method: POST
- body:
{ "cpf": "01706799349" }
Atributos do request #
Campo | Tipo | Descrição | Exemplo |
---|---|---|---|
cpf obrigatório | string | CPF (apenas números) do titular da conta | “01706799349” |
Response #
A resposta é apresentada segundo o JSON a seguir, ela representa o protocolo gerado junto à CAIXA. Esse protocolo será utilizado posteriormente para consulta do saldo do FGTS.
- status: 201
- body:
{ "protocolo": 1978499 }