Guide

Termo de Consentimento

Este endpoint é utilizado para gerar o termo de consentimento necessário para a consulta de dados do tomador de crédito no produto Crédito Privado CLT.
O termo de consentimento é um requisito legal e regulatório que autoriza a V8 Digital e o provedor parceiro a acessar e processar informações pessoais e financeiras do cliente para fins de análise de crédito e contratação.

Ao ser chamado, o endpoint registra os dados do tomador e do signatário (quando aplicável), vinculando-os a um identificador único de consulta. Esse identificador deve ser armazenado pelo integrador, pois será utilizado nas etapas seguintes do fluxo, como simulação.

Endpoint para gerar o termo de consentimento

URL: https://bff.v8sistema.com/private-consignment/consult

Método HTTP: POST

Autenticação: Requer token JWT válido no header da requisição.

Body da Requisição 

{
  "borrowerDocumentNumber": "string",
  "gender": "male",
  "birthDate": "2025-08-14",
  "signerName": "string",
  "signerEmail": "string",
  "signerPhone": {
    "phoneNumber": "string",
    "countryCode": "string",
    "areaCode": "string"
  },
  "provider": "QI"
}

Parâmetros da Requisição

  • borrowerDocumentNumber : string
    CPF do cliente que deseja consultar a margem.

  • gender: string(enum)

    devera ser informado como “male” ou “female”.

  • birthDate: string
    Data de nascimento do cliente.

  • signerName: string
    Nome do cliente.

  • signerEmail: string
    Email do cliente.

  • signerPhone: {

    • phoneNumber: string

      Numero de telefone do cliente.

    • countryCode: string

      Codigo país do telefone do cliente.

    • areaCode: string
      Codigo de area do telefone do cliente.

      }

    • provider: string

      Deverá ser informado como “QI”

Resposta

Em caso de sucesso (código HTTP 200), a resposta será a seguinte:

{
  "id": "string"
}

O retorno da requisição contém um identificador único que deverá ser utilizado nas etapas seguintes do processo (ex.: simulação).

Endpoint para listar os termos de consentimento gerados pelo usuário

URL: https://bff.v8sistema.com/private-consignment/consult

Método HTTP: GET

Autenticação: Requer token JWT válido no header da requisição.

Parâmetros da Requisição:

  • startDate: string (date-time), obrigatório
    Data/hora inicial do período em ISO 8601.
    Ex.: 2025-09-16T00:00:00Z

  • endDate: string (date-time), obrigatório
    Data/hora final do período em ISO 8601.
    Ex.: 2025-09-16T23:59:59Z

  • limit: integer, obrigatório
    Quantidade de registros por página (mínimo 1).
    Ex.: 50

  • page: integer, obrigatório
    Número da página (base 1; mínimo 1).
    Ex.: 1

  • search: string, opcional
    Busca por nome, número de documento (CPF/CNPJ).
    Ex.: 03898739007, GABRIEL.

  • status: string, opcional
    Status da consulta de consignação privada. Valores possíveis:
    WAITING_CONSENT,

    CONSENT_APPROVED,

    WAITING_CONSULT,

    WAITING_CREDIT_ANALYSIS,

    SUCCESS,

    FAILED,

    REJECTED
    Ex.: SUCCESS

  • provider: string, obrigatório (padrão: QI)
    Provedor utilizado para a consulta.
    Ex.: QI

Resposta

Em caso de sucesso (código HTTP 200), a resposta será a seguinte:

{
  "pages": {
    "current": 0,
    "hasNext": true,
    "hasPrev": true,
    "limit": 0,
    "total": 0,
    "totalPages": 0
  },
  "data": [
    {
      "id": "string",
      "partnerId": "string",
      "documentNumber": "string",
      "availableMarginValue": "string",
      "status": "string",
      "description": "string",
      "name": "string"
    }
  ]
}

Parâmetros da Resposta:

  • id: string (uuid), obrigatório
    Identificador único da consulta. Ex.: c1c7c2b9-8a4b-4b7e-9d2f-2a0a3b8d2b7e

  • status: string, obrigatório
    Status da consulta. Valores: WAITING_CONSENT, CONSENT_APPROVED, WAITING_CONSULT, WAITING_CREDIT_ANALYSIS, SUCCESS, FAILED, REJECTED.

  • partnerId: string
    Identificador do parceiro (interno/externo). Ex.: 10253_10253_915_D008

  • documentNumber: string
    Documento consultado (CPF — preferencialmente apenas dígitos). Ex.: 03898739007

  • name: string
    Nome do cliente consultado. Ex.: GABRIEL RODRIGUES FRANCA

  • availableMarginValue: string

    Margem disponivel para contratação do emprestimo CLT

  • Description: string
    Campo onde informa o motivo da rejeição pelo motor de crédito.

Endpoint para autorizar o termo de consentimento

URL: https://bff.v8sistema.com/private-consignment/consult

Método HTTP: POST

Parâmetros da Requisição

  • consult_id: string

Resposta

Em caso de sucesso (código HTTP 200), a resposta será a seguinte:

Successful response

ITEM OBRIGATÓRIO PARA USO DO CRÉDITO CLT VIA API

Abaixo segue modelo de exemplo para que seja informado no termo de consentimento que será desenvolvido do lado da sua aplicação

Aceite os Termos de Autorização!

Leia atentamente os termos antes de continuar. Ao prosseguir, você concorda com as condições estabelecidas para o uso da plataforma.

TERMO DE AUTORIZAÇÃO

Eu, <Nome_Cliente>, CPF <CPF_Cliente>, autorizo o MTE/DATAPREV a 
disponibilizar as informações abaixo indicadas para apoiar a 
contratação/simulação de empréstimo consignado, 
a fim de subsidiar a proposta pelo Banco Credor. 
Informações a serem disponibilizadas:

CPF
Matrícula
Inscrição do Empregador (Código e Descrição)
Número da Inscrição do Empregador
Nome
Sexo (Código e Descrição)
Data de Nascimento
Código da Categoria do Trabalhador
Elegibilidade (Sim/Não)
Valor Total dos Vencimentos
Valor Base da Margem
Valor da Margem Disponível
Data de Admissão
Data de Desligamento
Código do Motivo do Desligamento
Pessoa Exposta Politicamente (Código e Descrição)
Alertas de Afastamento e Aviso Prévio

Este termo autoriza esta Instituição Financeira a 
consultar as informações acima descritas durante um período 
de 30 dias. Este pedido poderá ser efetuado pela 
Instituição Financeira em até 45 dias após a assinatura 
deste instrumento.