Similarity - Brazil

Consulta responsável por comparar a integridade dos dados da Pessoa Física inseridos com os dados da base.

Casos de Uso

Integração com Similarity - Brazil | API de Comparação e Análise de Dados
Qualificação e roteamento inteligente de leads
Modelos de crédito e propensão
Segmentação e personalização de campanhas

Aplicações

Onboarding de Clientes e Fornecedores
Prevenção de Roubo de Identidade

Benefícios

Documentação de Similarity - Brazil | API de Comparação e Análise de Dados acessível e atualizada
Aumenta conversão com menos atrito
Melhora acurácia dos modelos
Dados prontos para uso analítico

Esta API permite comparar a integridade dos dados fornecidos de uma Pessoa Física com os registrados na base, avaliando possíveis inconsistências em atributos como nome, CPF, endereço, e outros.

URL Base

A API está hospedada no seguinte endereço:

https://apiv3.directd.com.br/api/Similarity

Endpoint

GET https://apiv3.directd.com.br/api/Similarity?Cpf={0}&Name={1}&Surname={2}&DOB={3}&Address={4}&City={5}&State={6}&PostCode={7}&Phone={8}&Token=Seu_Token

Descrição: Endpoint para realizar consultas Similarity - Brazil.

Nota: Esta consulta não gera comprovantes.

Campos Retornados

Address: Informa o endereço do indivíduo
City: Cidade do registro em questão
CPF: CPF do indivíduo
Descrição dos Cinco Primeiros Dígitos: Descrição do registro para os cinco primeiro dígitos informados.
Description: Descrição do registro
Distance: Informa, com valores, a distância entre o termo perquisado e o comparado
Distância dos Cinco Primeiros Dígitos: Informa, com valores, a distância entre o termo perquisado e o comparado.
DOB: Data de nascimento do indivíduo
Name: Nome do indivíduo/registro
Phone: Telefones vinculados ao indivíduo
PostCode: Número CEP/código postal do endereço
State: Nome do estado

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
`PHONE`	string	Não	Caso haja mais de um telefone, use “\|” (sem aspas) para separá-los. Ex: 11912345678 \| 11987654321.
`POSTCODE`	string	Não	CEP - Ex: 12345-123.
`STATE`	string	Não	ESTADO - Ex: SP.
`CITY`	string	Não	NOME DA CIDADE.
`ADDRESS`	string	Não	ENDEREÇO - Ex: Rua Óbidos, 674.
`DOB`	string	Sim	DATA DE NASCIMENTO - Ex: yyyy/MM/dd.
`SURNAME`	string	Sim
`NAME`	string	Sim
`CPF`	string	Sim	O parâmetro CPF pode ser enviado com ou sem formatação. Este parâmetro não é obrigatório, mas caso não utilizado, enviar os parâmetros 'NAME', 'SURNAME' e 'DOB'.
`TOKEN`	string	Sim	O parâmetro TOKEN é essencial para efetuar esta consulta. Em caso de dúvidas, por favor, entre em contato com: suporte@directd.com.br

Exemplo de Resposta

{
  "metaDados": {
    "consultaNome": "string",
    "consultaUid": "string",
    "chave": "string",
    "usuario": "string",
    "mensagem": "string",
    "ip": "string",
    "resultadoId": 0,
    "resultado": "string",
    "apiVersao": "v3",
    "enviarCallback": false,
    "gerarComprovante": false,
    "urlComprovante": "string",
    "assincrono": true,
    "data": "dd/MM/yyyy HH:mm:ss",
    "tempoExecucaoMs": 0
  },
  "retorno": {
    "cpf": {
      "cpf": "string",
      "description": "string",
      "distance": 0
    },
    "name": {
      "name": "string",
      "description": "string",
      "distance": 0
    },
    "dob": {
      "dob": "string",
      "description": "string",
      "distance": 0
    },
    "address": {
      "address": "string",
      "description": "string",
      "distance": 0
    },
    "city": {
      "city": "string",
      "description": "string",
      "distance": 0
    },
    "state": {
      "state": "string",
      "description": "string",
      "distance": 0
    },
    "postCode": {
      "postCode": "string",
      "description": "string",
      "distance": 0,
      "descriptionOnFirstFiveDigits": "string",
      "distanceOnFirstFiveDigits": 0
    },
    "phone": [
      {
        "phone": "string",
        "description": "string",
        "distance": 0
      }
    ]
  }
}

Erros Comuns

Código	Descrição
400	Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos.
401	Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso.
403	Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível.
404	Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado.
408	Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido.
500	Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte.
503	Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte.

Notas Importantes

Informe apenas um único documento por requisição
Para utilizar a consulta de forma assíncrona, utiliza-se: '&async=habilitar' na URL
Em caso de dúvidas/suporte, entre em contato pelo e-mail: suporte@directd.com.br ou pelo nosso WhatsApp: (11) 93906-9228