O Banco Semear é uma instituição financeira comprometida em promover a inclusão financeira, oferecendo soluções sob medida para o mercado.
Essa documentação tem por objetivo auxiliar o desenvolvedor da instituição parceira do Banco Semear a integrar seus serviços à API Rest de empréstimo por garantia do Saque Aniversário do FGTS.
O que é o saque aniversário FGTS? #
A sistemática permite o saque de parte do saldo de FGTS, anualmente, no mês de aniversário. Caso o trabalhador opte por esse sistema ele passa a ter o direito de sacar parte do saldo de suas contas vinculadas do FGTS, anualmente, no mês do seu aniversário. Com a opção por esse sistema, o trabalhador também pode utilizar os recursos do saque-aniversário FGTS como garantia para tomada de empréstimos nas instiuições financeiras credenciadas, e o Banco Semear atua para possibilitar tais concessões.
Como funciona no Banco Semear? #
A interação para criação da operação ocorre conforme os seguintes passos:
- Consulta do saldo de aniversário de FGTS disponível para a antecipação.
- Simulação dos valores disponíveis para a antecipação.
- Validação das políticas de crédito e fraude e reserva dos valores na Caixa Econômica Federal.
- Criação do contrato da Operação de Antecipação de sque de aniversário do FGTS.
Cada parte da operação possui seu próprio endpoint que será explicado em detalhes nas próximas sessões.
Consulta do saldo de aniversário de FGTS disponível para a antecipação #
Para que a consulta seja feita, o parceiro com posse do CPF do cliente, deverá chamar 2 API’s, sendo elas:
- Consulta CPF: onde se envia o CPF e tem como retorno um Protocolo;
- Consulta Protocolo: onde com a informação do Protocolo vindo da API anterior, se recebe as informações dos saldos.
Simulação dos valores disponíveis para a antecipação #
Nessa funcionalidade temos uma API que recebe as informações dos Saldos disponíveis que foram retornados na API de Consulta Protocolo e retorna os valores simulados do empréstimo, como por exemplo, valor líquido do empréstimo, IOF, tarifas, etc.
Nome da API: Simulação
Validação de políticas de crédito, fraude e reserva dos valores na Caixa Econômica Federal #
Nessa funcionalidade temos uma API que recebe as informações simuladas e aceitas pelo cliente, que foram retomadas na API de Simulação. Consiste as políticas de crédito e fraude, gera a CCB e retorna um link que deverá ser disponibilizado ao cliente final para a validação e confirmação das informações do cliente e da antecipação.
Nome da API: Inserir Proposta
Criação do contrato da Operação de Antecipação de saque de aniversário do FGTS #
Após o cliente ter passado pela jornada (via link) onde o próprio validará suas informações pessoais e assinará o contrato de crédito, o sistema do Banco SEMEAR fará a liberação do crédito e a criação do contrato do crédito.
Após a finalização desse processo, o Parceiro será avisado.
Temos também outras duas APIs para as seguintes funcionalidades:
- Consulta dados da Proposta: Nela, através do ID da proposta, é possível consultar as informações sobre a proposta e seu status atual.
Nome da API: Consulta Proposta - Cancelamento da Proposta: Nela, através do ID da proposta, é possível cancelar uma proposta que ainda não tenha ocorrido o desembolso do valor ao cliente. Nesse momento, será feito o desbloqueio da reserva do saldo na Caixa Econômica Federal.
Nome da API: Cancelar Proposta
Pré-requisito de negócio #
Para que o cliente possa usufruir deste produto, é necessário que o parceiro o oriente a acessar o aplicativo do FGTS e realizar os seguintes procedimentos:
- autorizar a opção de Saque-Aniversário;
- conceder autorização ao Banco SEMEAR para consulta de suas informações.
Informações importantes #
Antes de começar, verifique a disponibilidade de acesso junto ao Banco Semear.
Acesse a guia “Antes de começar”
