💡Esta API permite comparar a integridade dos dados fornecidos do Código de Registro de População Única do México (CURP) com os registrados na base, avaliando possíveis inconsistências em atributos como nome, CURP, endereço, e outros.
Introdução
A API Similarity - México é voltada para validação de dados cadastrais, reduzindo inconsistências em processos como onboarding de clientes e prevenção de fraudes. É uma ferramenta ideal para empresas que desejam verificar a confiabilidade de dados em tempo real.
URL Base
https://api.directd.com.br
Endpoint
GET /api/SimilarityMexico
Descrição: Endpoint para realizar validação de integridade dos dados inseridos com os dados armazenados na base.
Nota: Esta consulta não gera comprovantes.
Autenticação
O acesso a esta API requer um token válido.
- O token deve ser enviado como parâmetro na URL da requisição.
- Para dúvidas sobre autenticação, entre em contato com suporte@directd.com.br.
Campos da API
Dados Pessoais
- CURP: Código de Registro de População Única.
- Name: Nome completo.
- DOB: Data de nascimento.
Endereço
- Address: Endereço completo.
- City: Cidade.
- State: Estado.
- PostCode: Código postal.
Contato
- Phone: Número de telefone (pode incluir múltiplos valores separados por "|").
Parâmetros
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
CURP | string | Não | CURP do indivíduo. Se omitido, use NAME, SURNAME e DOB. |
NAME | string | Não | Nome do indivíduo. |
SURNAME | string | Não | Sobrenome do indivíduo. |
DOB | string | Não | Data de nascimento (formato yyyy/MM/dd). |
ADDRESS | string | Não | Endereço completo. |
CITY | string | Não | Nome da cidade. |
STATE | string | Não | Estado. |
POSTCODE | string | Não | Código postal. |
PHONE | string | Não | Telefone (ou telefones separados por "|"). |
TOKEN | string | Sim | Token de autenticação. |
Exemplos de Requisição
Usando cURL
curl 'https://api.directd.com.br/api/SimilarityMexico?CURP=ABCDE123456MNOPQR7&TOKEN=seu_token_aqui'
Respostas
Sucesso (200)
Exemplo de Resposta
{
"metaDados": {
"consultaNome": "Similarity - México",
"consultaUid": "directd-123456",
"usuario": "Cliente",
"mensagem": "Sucesso",
"apiVersao": "v3",
"tempoExecucaoMs": 3045
},
"retorno": {
"curp": {
"curp": "ABCDE123456MNOPQR7",
"description": "CURP válido",
"distance": 0
},
"name": {
"name": "JUAN PEREZ",
"description": "Nome correto",
"distance": 1
},
"address": {
"address": "Calle Ejemplo, 123",
"description": "Endereço parcialmente compatível",
"distance": 3
}
}
}
Erros Comuns
Código | Descrição |
---|---|
400 | Requisição inválida: parâmetros incorretos. |
401 | Não autenticado: token inválido ou ausente. |
403 | Não autorizado: saldo insuficiente para realizar a consulta. |
404 | Não encontrado: registro não localizado. |
408 | Tempo esgotado: consulta não foi concluída no prazo. |
500 | Erro interno: falha no processamento da consulta. |
503 | Serviço em manutenção: indisponível temporariamente. |