Campos disponíveis para validação
Veja abaixo os campos possíveis de validação. Para detalhes técnicos, acesse a Referência da API disponibilizada em OAS/Swagger, um padrão bastante utilizado de documentação de APIs. Veja abaixo como encontrar os campos disponíveis para validação na Referência da API.
Campos para validação biométrica
Para comparação biométrica, o Datavalid disponibiliza a validação por reconhecimento facial e/ou impressões digitais de condutores, cidadãos que possuem CNH (licença para dirigir).
Saiba mais detalhes sobre os requisitos para validação de imagens (facial ou impressão digital) no artigo Requisitos para Envio de Imagens.
Conheça, também, as perguntas frequentes sobre os dados biométricos na área de FAQ.
| BASE ORIGEM | CAMPOS BIOMÉTRICOS | INPUT | RETORNO |
|---|---|---|---|
| Renach (CNH) | Biometria - Facial (biometria_face) |
JPG, PDF ou PNG codificados em base64 |
disponivel: true/false probabilidade: Baixíssima, Baixa, Alta ou Altíssima probabilidade similaridade: 0 até 1, onde 1=100% |
| Renach (CNH) | Biometria - Impressão Digital (digitais) |
ISO, JPG, PNG ou WSQ codificados em base64 Posição da digital 0 - polegar direito 1 - indicador direito 2 - dedo médio direito 3 - dedo anelar direito 4 - dedo minímo direito 5 - polegar esquerdo 6 - indicador esquerdo 7 - dedo médio esquerdo 8 - dedo anelar esquerdo 9 - dedo minímo esquerdo |
disponivel: true/false probabilidade: Baixíssima, Baixa, Alta ou Altíssima probabilidade similaridade: 0 até 1, onde 1=100% |
Campos para validação biográfica
Para a comparação biográfica, o Datavalid disponibiliza a validação de dados cadastrais de Pessoa física (PF) e Pessoa jurídicas (CNPJ)
Campos para validação biográfica de Pessoa Física
Lista de campos disponíveis para validação de dados de pessoa física por meio do Datavalid.
Importante atentar que:
- Para CPFs que não tenham CNH, somente os campos: Número de inscrição, Nome, Data de Nascimento e Situação do CPF serão passíveis de validação.
- A partir da versão 3 do Datavalid está disponível o retorno
cnh_disponivel: true/falseque indica se o CPF possui CNH. - Campo “codigo_situacao” da CNH
Visando simplificar a utilização do campo codigo_situacao da CNH, reduzimos a quantidade de opções de validação deste campo, ficando apenas 3 opções: “emitida”, “cancelada” e “em emissão”. Saiba mais. - Campo “observacoes” da CNH
O campo observacoes não possui tabela de domínio no Datavalid. Dentro deste campo deverão constar as restrições médicas e a informação sobre o exercício de atividade remunerada, todos em formato padronizados e abreviados conforme Anexo II desta Resolução (850/2021); "(NR) Art. 3º Ficam revogados os códigos 11, 12, 13, 14, 17, 18 e 19 previstos na TABELA DE ABREVIATURAS A SEREM IMPRESSAS NA CARTEIRA NACIONAL DE HABILITAÇÃO constante no ANEXO II da Resolução CONTRAN nº 598, de 2016.” Os Cursos especiais deixaram de fazer parte do campo observações da CNH em outubro/2021. CNH(s) emitidas antes desta data poderão ainda ter impressos as abreviaturas referentes aos códigos citados. - Para obter as informações completas com detalhes e o correto uso dos campos, consulte a referência da API.
| BASE ORIGEM | CAMPO BIOGRÁFICO | TABELA DE DOMÍNIO | RETORNO |
|---|---|---|---|
| RFB | cpf | - | cpf_disponivel: true/false |
| RFB | situacao_cpf | - regular - suspensa - titular falecido - pendente de regularização - cancelada por multiplicidade - nula - cancelada de oficio |
situacao_cpf: true/false |
| RFB | data_nascimento | - | data_nascimento: true/false |
| RFB e Renach (CNH) |
nome | - | nome: true/false nome_similaridade: de 0 até 1, onde 1=100% |
| Renach (CNH) | sexo | F - feminino M - masculino O - outro |
sexo: true/false |
| Renach (CNH) | nacionalidade | 1 - brasileiro 2 - brasileiro naturalizado 3 - estrangeiro 4 - brasileiro nascido no exterior |
nacionalidade: true/false |
| Renach (CNH) | nome_mae | - | nome_mae: true/false nome_mae_similaridade: de 0 até 1, onde 1=100% |
| Renach (CNH) | nome_pai | - | nome_pai: true/false nome_pai_similaridade: de 0 até 1, onde 1=100% |
| Renach (CNH) | categoria | - | categoria: true/false |
| Renach (CNH) | observacoes | - | observacoes: true/false observacoes_similaridade: de 0 até 1, onde 1=100% |
| Renach (CNH) | numero_registro | - | numero_registro: true/false |
| Renach (CNH) | data_primeira_pabilitacao | - | data_primeira_habilitacao: true/false |
| Renach (CNH) | registro_nacional_estrangeiro | - | data_validade: true/false |
| Renach (CNH) | registro_nacional_estrangeiro | - | registro_nacional_estrangeiro: true/false |
| Renach (CNH) | data_ultima_emissao | - | data_ultima_emissao: true/false |
| Renach (CNH) | codigo_situacao | 2 - em emissão 3 - emitida A - cancelada |
codigo_situacao: true/false |
| Renach (CNH) | possui_impedimento | - | possui_impedimento: true/false |
| Renach (CNH) | documento/tipo | 1 - carteira de identidade 2 - carteira profissional 3 - passaporte 4 - carteira de reservista |
tipo: true/false |
| Renach (CNH) | documento/numero | - | numero: true/false numero_similaridade: de 0 até 1, onde 1=100% |
| Renach (CNH) | documento/orgao_expedidor | - | orgao_expedidor: true/false |
| Renach (CNH) | documento/uf_expedidor | AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO | uf_expedidor: true/false |
| Renach (CNH) | endereco/logradouro | - | logradouro: true/false |
| Renach (CNH) | endereco/complemento | - | complemento: true/false |
| Renach (CNH) | endereco/numero | - | numero: true/false numero_similaridade: de 0 até 1, onde 1=100% |
| Renach (CNH) | endereco/bairro | - | bairro: true/false |
| Renach (CNH) | endereco/cep | - | cep: true/false |
| Renach (CNH) | endereco/municipio | - | municipio: true/false |
| Renach (CNH) | endereco/uf | AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO | uf: true/false |
Campos para validação biográfica de Pessoa Jurídica
Lista de campos de pessoa jurídica disponíveis para validação por meio do Datavalid
| BASE ORIGEM | CAMPO BIOGRÁFICO | TABELA DE DOMÍNIO | RETORNO |
|---|---|---|---|
| RFB | cnpj | cnpj_disponivel: true/false | |
| RFB | razao_social | razao_social: true/false razao_social_similaridade: de 0 até 1, onde 1=100% |
|
| RFB | nome_fantasia | nome_fantasia: true/false nome_fantasia_similaridade: de 0 até 1, onde 1=100% |
|
| RFB | data_abertura | data_abertura: true/false | |
| RFB | porte | 00 - não informado 01 - microempresa 03 - empresa pequeno porte 05 - empresa grande porte |
porte: true/false |
| RFB | situacao_especial | situacao_especial: true/false situacao_especial_similaridade: de 0 até 1, onde 1=100% |
|
| RFB | correio_eletronico | correio_eletronico: true/false correio_eletronico_similaridade: de 0 até 1, onde 1=100% |
|
| RFB | capital_social | capital_social: true/false | |
| RFB | telefone - ddd | ddd: true/false | |
| RFB | telefone - numero | numero: true | |
| RFB | endereco - logradouro | logradouro: true/false logradouro_similaridade: de 0 até 1, onde 1=100% |
|
| RFB | endereco - numero | numero: true/false numero_similaridade: de 0 até 1, onde 1=100% |
|
| RFB | endereco - complemento | complemento: true/false complemento_similaridade: de 0 até 1, onde 1=100% |
|
| RFB | endereco - bairro | bairro: true/false bairro_similaridade: de 0 até 1, onde 1=100% |
|
| RFB | endereco - cep | cep: true/false | |
| RFB | endereco - municipio | municipio: true/false municipio_similaridade: de 0 até 1, onde 1=100% |
|
| RFB | endereco - uf | AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO | uf: true/false |
| RFB | cnae_principal - codigo | codigo: true/false | |
| RFB | cnae_principal - descricao | descricao: true/false descricao_similaridade: de 0 até 1, onde 1=100% |
|
| RFB | natureza_juridica - codigo | codigo: true/false | |
| RFB | natureza_juridica - descricao | descricao: true/false descricao_similaridade: de 0 até 1, onde 1=100% |
|
| RFB | situacao_cadastral - codigo | 2 - ativa 3 - suspensa 4 - inapta 8 - baixada |
codigo: true/false |
| RFB | situacao_cadastral - data | data: true/false | |
| RFB | situacao_cadastral - motivo | motivo: true/false motivo_similaridade: de 0 até 1, onde 1=100% |
O que são campos objetivos
Os campos objetivos são campos com preenchimento definido, com regra de preenchimento. As opções de preenchimento são limitadas, seja pela tabela de domínio ou pelo conteúdo esperado no campo, por exemplo, data de nascimento ou ou categoria da CNH. Esta característica se aplica aos campos de pessoa física e pessoa jurídica.
Exemplo da validação com campo “data de nascimento” cujo registro fictício na base seja “04/06/1975”
Entrada:
"data_nascimento": "1975-06-04"
Retorno:
"data_nascimento": true
O que são campos descritivos
Os campos descritivos são campos com preenchimento de texto livre, sem regra de preenchimento, como “nome” ou “nome da mãe”, por exemplo. Esta característica se aplica aos campos de pessoa física e pessoa jurídica.
Exemplo da validação com campo “nome” cujo registro na base fictícia seja “Manuela Elisa da Mota”
Entrada:
"nome": "Manuela Elisa da Mota"
Retorno:
"nome": true,
"nome_similaridade": 1
Para campos descritivos, o retorno será "true" se a similaridade for 100% (=1) ou "false" se menor que 100%.