Documentação da API

DSV Digi — integração de simulação e digitação de propostas

Produto: FGTS CLT — em breve Atualizado em 09/07/2026

Autenticação

Todas as requisições exigem o envio do header abaixo:

HTTP HEADER
Authorization: Bearer d1988e1a7f5ab35fa45b4ccfa0f199fe

GET Método: Simulação FGTS

Endpoint

GEThttps://api.dsvdigi.com.br/webhook/consulta-saldo

Header

HTTP HEADER
Authorization: Bearer d1988e1a7f5ab35fa45b4ccfa0f199fe

Corpo da Requisição — // obrigatório indica campo obrigatório

JSON
{
  "cpf": "00000000000",  // obrigatório
  "bank": "bmp",  // obrigatório
  "desired_value": "",
  "api_token": "0000000000"  // obrigatório
}
ℹ️
Ao realizar a simulação sem fornecer o valor desejado desired_value, a simulação será realizada com todo o valor disponível para o cliente.

Retorno de Sucesso

JSON · 200 OK
{
  "cpf": "12345678910",
  "message": "Saldo consultado com sucesso!",
  "returned_an_error": false,
  "available_balance": "141.51",
  "status_code": "200",
  "simulation_id": "a81ec9bc-fcec-4b7b-92db-025e851f6b7e",
  "net_value": "87.73",
  "gross_value": "153.66",
  "monthly_cet": "4.55367",
  "annual_cet": "70.6362",
  "monthly_fee": "1.79",
  "annual_interest": "23.72611",
  "tc_value": "53.78",
  "iof_value": "4.76",
  "interest_value": "105.36",
  "blocked_balance": "259.02",
  "table_id": "9baa1f9f-08ff-4578-a96d-e6457bc2ca76",
  "table_name": " OF THE KING THE POWER THE BEST 50,00 a 250,00",
  "tc_percentage": "tc_percentage = 35",
  "allow_simulate_by_installments": "false",
  "min_installment_amount": "1",
  "max_installment_amount": "12",
  "installments": [
    {
      "date": "2026-04-01",
      "available_value": 78.06,
      "released_value": 64.11703
    }
    // ...
  ]
}

POST Método: Cadastrar Proposta FGTS

Endpoint

POSThttps://api.dsvdigi.com.br/webhook/cadastrar-proposta

Header

HTTP HEADER
Authorization: Bearer d1988e1a7f5ab35fa45b4ccfa0f199fe

Corpo da Requisição — // obrigatório indica campo obrigatório

Nome, CPF, Data de nascimento, Celular/Whatsapp e dados bancários. Enviar dados reais do cliente. O campo simulation.id deve ser o mesmo retornado no Método: Simulação.

JSON
{
  "api_token": "00000000",  // obrigatório
  "customer": {
    "pf": {
      "name": "João Paulo",  // obrigatório
      "cpf": "12345678910",  // obrigatório
      "birth_date": "1992-04-27",  // obrigatório
      "gender": "M",  // obrigatório
      "civil_status_id": "2",  // obrigatório
      "scholarity_id": "8",  // obrigatório
      "rg_number": "123456",
      "rg_organ": "SSP",
      "rg_uf": "SP"
    },
    "contacts": {
      "email": "emaildocliente@email.com",  // obrigatório
      "celphone": "11988887777"  // obrigatório
    },
    "address": {
      "zipcode": "04107030",  // obrigatório
      "street": "Rua Guimarães Passos",  // obrigatório
      "district": "Vila Mariana",  // obrigatório
      "uf": "SP",  // obrigatório
      "number": "323",  // obrigatório
      "complement": "Casa",  // obrigatório
      "city": "São Paulo"  // obrigatório
    },
    "account": {
      "bank_id": "341",  // obrigatório
      "type": "CCT",  // obrigatório
      "agency": "0001",  // obrigatório
      "agency_digit": "0",  // obrigatório
      "account_number": "0045958",  // obrigatório
      "account_digit": "0"  // obrigatório
    }
  },
  "simulation": {
    "id": "a81ec9bc-fcec-4b7b-92db-025e851f6b7e"  // obrigatório
  }
}

Retorno de Sucesso

JSON
[
  {
    "data": {
      "proposal_code": "366dc20e-af9f-4ff3-a953-8939cabea3cf"
    },
    "message": "Proposta cadastrada com sucesso!"
  }
]

POST Método: Cadastrar Proposta (PIX) FGTS

Idêntico ao Método: Cadastrar Proposta, exceto pelo objeto account, que agora recebe uma chave PIX em vez dos dados bancários (banco, agência e conta).

Endpoint

POSThttps://api.dsvdigi.com.br/webhook/cadastrar-proposta-pix

Header

HTTP HEADER
Authorization: Bearer d1988e1a7f5ab35fa45b4ccfa0f199fe

Corpo da Requisição — // obrigatório indica campo obrigatório

Nome, CPF, Data de nascimento, Celular/Whatsapp e chave PIX. Enviar dados reais do cliente. O campo simulation.id deve ser o mesmo retornado no Método: Simulação.

JSON
{
  "api_token": "00000000",  // obrigatório
  "customer": {
    "pf": {
      "name": "João Paulo",  // obrigatório
      "cpf": "12345678910",  // obrigatório
      "birth_date": "1992-04-27",  // obrigatório
      "gender": "M",  // obrigatório
      "civil_status_id": "2",  // obrigatório
      "scholarity_id": "8",  // obrigatório
      "rg_number": "123456",
      "rg_organ": "SSP",
      "rg_uf": "SP"
    },
    "contacts": {
      "email": "emaildocliente@email.com",  // obrigatório
      "celphone": "11988887777"  // obrigatório
    },
    "address": {
      "zipcode": "04107030",  // obrigatório
      "street": "Rua Guimarães Passos",  // obrigatório
      "district": "Vila Mariana",  // obrigatório
      "uf": "SP",  // obrigatório
      "number": "323",  // obrigatório
      "complement": "Casa",  // obrigatório
      "city": "São Paulo"  // obrigatório
    },
    "account": {
      "pix_key": "11999999999",  // obrigatório
      "pix_key_type": "phone"  // obrigatório
    }
  },
  "simulation": {
    "id": "a81ec9bc-fcec-4b7b-92db-025e851f6b7e"  // obrigatório
  }
}

Retorno de Sucesso

JSON
[
  {
    "data": {
      "proposal_code": "366dc20e-af9f-4ff3-a953-8939cabea3cf"
    },
    "message": "Proposta cadastrada com sucesso!"
  }
]

Tipos de Chave PIX pix_key_type

TipoValorFormato esperado em pix_key
emailE-mailemaildocliente@email.com
phoneTelefoneApenas números, com DDD — 11999999999
randomChave aleatóriaUUID — 123e4567-e12b-12d1-a456-426655440000
cpfCPFApenas números — 12345678910
cnpjCNPJApenas números — 12345678000199

POST Método: Buscar Dados da Proposta FGTS

Endpoint

POSThttps://api.dsvdigi.com.br/webhook/buscar-dados-proposta

Header

HTTP HEADER
Authorization: Bearer d1988e1a7f5ab35fa45b4ccfa0f199fe

Corpo da Requisição

JSON
{
  "cpf_proposta": "00000000000",
  "api_token": "0000000000"
}

Retorno de Sucesso

JSON · 200 OK
{
  "success": true,
  "returned_an_error": false,
  "status_code": 200,
  "message": "Proposta encontrada",
  "ccb": "00012345",
  "status": "Cancelada",
  "cpf_proposta": "123.456.789-00",
  "nome": "João Paulo da Silva",
  "email": "",
  "celular": "11999999999",
  "valor_proposta": "400",
  "link_assinatura": "https://assinar.io/123456"
}

GET Método: Consultar CCB / Pegar link FGTS

Endpoint

GEThttps://api.dsvdigi.com.br/webhook/consulta-proposta

Header

HTTP HEADER
Authorization: Bearer d1988e1a7f5ab35fa45b4ccfa0f199fe

Corpo da Requisição

JSON
{
  "api_token": "0000000000",
  "ccb": "00000000"
}

Retorno de Sucesso

JSON
{
  "ccb": "A0001234",
  "status": "Cancelada",
  "link_assinatura": "https://assinar.io/123456",
  "mensagem_pendencia": "teste"
}

Padrões de Campos

CampoFormatoExemplo
Data de NascimentoAAAA-MM-DD1992-04-27
CelularApenas números, com DDD11932217311

Tabelas de Referência

Gênero

CódigoValor
MMasculino
FFeminino

Estado Civil

IdValor
1Solteiro(a)
2Casado(a)
3Divorciado(a)
4Separado(a)
5Viúvo(a)
6Outros

Escolaridade

IdValor
1Maternal incompleto
2Maternal completo
3Ensino fundamental incompleto
4Ensino fundamental completo
5Ensino médio incompleto
6Ensino médio completo
7Ensino superior incompleto
8Ensino superior completo

Tipos de Conta Bancária

IdValor
CPPConta Poupança
CCTConta Corrente
CPGConta Pagamento