Analisador de ID (Pré-visualização)
ID Analyzer fornece vários produtos diferentes de verificação de identidade, você precisa adquirir conhecimento básico de cada produto, a fim de escolher a melhor solução para a sua aplicação.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte ao Analisador de ID |
| URL | https://www.idanalyzer.com/contact.html |
| support@idanalyzer.com |
| Metadados do conector | |
|---|---|
| Editora | Evith Tecnologia |
| Sítio Web | https://www.idanalyzer.com/ |
| Política de privacidade | https://www.idanalyzer.com/privacy-policy.html |
| Categorias | Operações de TI; Produtividade |
A plataforma ID Analyzer fornece a empresas, organizações e indivíduos uma solução de verificação de identidade verdadeiramente global que funciona sem fronteiras, uma solução que pode ser adaptada às suas necessidades e demandas específicas e um sistema de segurança que está constantemente sendo atualizado e melhorado.
Fornecendo acesso e informações completas de verificação de identidade em mais de 4000+ formas diferentes de identificação em 190+ países ao redor do mundo, esta é uma solução global projetada com o mundo moderno em mente.
Pré-requisitos
- Uma conta de desenvolvedor com o ID Analyzer. Você pode se registrar para uma conta gratuita em Inscreva-se
- Depois de se registrar para a conta, você receberá uma chave de API no portal da web do ID Analyzer. Use essa chave de API para autenticar com o conector
Como obter credenciais
- Navegue até Inscrever-se
- Insira as informações necessárias.
- Verifique seu e-mail quando solicitado.
- Você verá sua nova chave de API no portal da Web do ID Analyzer com os detalhes da sua conta. Pressione o botão "Copiar" para salvá-lo na área de transferência para uso posterior.
FAQ
Estou preocupado com a privacidade do meu cliente, a API salva informações sobre o meu cliente?
Tudo será armazenado apenas no cofre do cliente e não será vazado arbitrariamente. Não terá nenhuma cópia em outro lugar.
Para que servem os "créditos", como posso comprar créditos API?
Crédito pré-pago restante para a sua conta. Se você tiver um plano mensal, sua cota mensal será usada antes do crédito pré-pago.
Como posso verificar se um documento é real ou falso?
Ative a autenticação, o resultado conterá a pontuação de autenticação.
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | Parâmetros para criar conexão. | Todas as regiões | Não compartilhável |
Padrão
Aplicável: Todas as regiões
Parâmetros para criar conexão.
Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave API API | securestring | A chave de API para esta api | Verdade |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Adicionar imagem ao Vault |
Você pode carregar uma imagem e adicioná-la a uma entrada de cofre existente fazendo uma solicitação HTTP POST. |
| Atualizar entrada do cofre |
Você pode atualizar o valor de um único campo ou valores de vários campos em uma entrada do vault fazendo uma solicitação HTTP POST. |
| Configuração da API principal |
API de verificação de ID multifuncional para verificar o documento físico remoto, sua autenticidade e a correspondência facial do documento com sua foto de usuário. |
|
Criando sessão de assinatura do Docu |
Você pode criar uma sessão de assinatura em que o usuário revisará e assinará o documento legal sem verificação de identidade. Se você quiser realizar a verificação de identidade e fazer com que seu usuário assine algum documento, crie uma sessão de verificação de identidade. |
|
Criando sessão Docu |
Você pode criar uma sessão de verificação para cada usuário que precise de verificação de identidade. |
| Estado da Formação |
Verifique se o treinamento do vault ainda está em andamento ou foi concluído. |
| Excluir entrada do Vault |
Você pode excluir uma ou várias entradas do cofre fazendo uma solicitação HTTP POST. |
| Excluir imagem do Vault |
Você pode excluir uma imagem dentro de uma entrada do cofre fazendo uma solicitação HTTP POST. Observe que, depois que uma imagem é excluída, o URL para a imagem ainda pode estar acessível por um curto período de tempo devido ao cache. |
| Listar e filtrar entradas |
Para listar todas as entradas armazenadas dentro do cofre ou procurar entradas com valores específicos, envie uma solicitação HTTP POST para o ponto de extremidade a seguir. |
| Obter conteúdo de entrada do Vault |
Quando as entradas são adicionadas ao vault, tanto a API Core quanto a API DocuPass retornarão um identificador de entrada do vault chamado vaultid. Você pode usar o identificador para consultar o conteúdo de uma entrada no cofre enviando uma solicitação HTTP POST para o ponto de extremidade a seguir. |
| Pesquisa de rostos |
A pesquisa facial permite-lhe pesquisar todo o cofre utilizando uma imagem de uma pessoa. Para usar o recurso de pesquisa de rosto, você deve habilitar a indexação de pesquisa de rosto no portal da Web e treinar seus conjuntos de dados do cofre periodicamente. |
| Pesquisando banco de dados AML |
A API AML permite pesquisar o banco de dados AML global do ID Analyzer para sanções, PEPs e criminosos procurados usando um nome, número de documento ou ambos. Pode ainda filtrar os resultados com data de nascimento e nacionalidade. |
| Treinamento de pesquisa facial |
Antes de realizar a pesquisa facial, você deve emitir um comando train para treinar os conjuntos de dados de documentos dentro do seu cofre. Você também pode treinar seus dados do cofre através do portal da web. A tarefa de treinamento é assíncrona, o tempo de treinamento depende do número de entradas e imagens do vault. Pode levar de vários segundos a uma hora. |
| Validando o retorno de chamada |
Para se certificar de que os dados foram enviados a partir do nosso servidor. |
Adicionar imagem ao Vault
Você pode carregar uma imagem e adicioná-la a uma entrada de cofre existente fazendo uma solicitação HTTP POST.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível em seu Portal da Web. |
|
id
|
id | True | string |
Identificador de entrada do Vault ao qual adicionar imagem |
|
tipo
|
type | True | string |
Defina o tipo de imagem: 0=documento e 1=pessoa |
|
imagem
|
image | string |
Dados de imagem codificados em Base64. |
|
|
imageurl
|
imageurl | string |
URL de imagem remota. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
sucesso
|
success | integer | |
|
id
|
image.id | string |
Identificador de imagem |
|
tipo
|
image.type | string |
0 para documento e 1 para pessoa |
|
hash
|
image.hash | string |
Hash MD5 da imagem |
|
URL
|
image.url | string |
URL para a imagem |
|
CreateTime
|
image.createtime | string |
A imagem da hora foi carregada em UTC |
Atualizar entrada do cofre
Você pode atualizar o valor de um único campo ou valores de vários campos em uma entrada do vault fazendo uma solicitação HTTP POST.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível em seu Portal da Web. |
|
id
|
id | True | string |
Identificador de entrada do cofre. |
|
Endereço1
|
address1 | string |
Endereço linha 1. |
|
|
Endereço2
|
address2 | string |
Endereço linha 2. |
|
|
bloco
|
block | string |
Defina esse parâmetro para impedir que o mesmo documento seja enviado à API principal ou ao DocuPass. 0: Não caixa 1: Bloquear o documento n.º 2: Bloquear o nome/apelido 3: Bloquear o número do documento e o nome/apelido. |
|
|
dados personalizados1
|
customdata1 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada. |
|
|
dados personalizados2
|
customdata2 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada. |
|
|
dados personalizados3
|
customdata3 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada. |
|
|
dados personalizados4
|
customdata4 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada. |
|
|
dados personalizados5
|
customdata5 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada. |
|
|
DOB
|
dob | string |
Data de nascimento (AAAA-MM-DD). |
|
|
Nome do documento
|
documentName | string |
Nome do documento. |
|
|
Número do documento
|
documentNumber | string |
O identificador único do documento (N.º do Passaporte/N.º da Carta de Condução, etc.) |
|
|
Tipo de documento
|
documentType | string |
P: Passaporte D: Carta de Condução I: Bilhete de Identidade V: Visa R: Cartão de Residência O: Outro |
|
|
docupass_customid
|
docupass_customid | string |
customid passado ao criar a verificação DocuPass. |
|
|
docupass_failedreason
|
docupass_failedreason | string |
Se a verificação do DocuPass falhou, o motivo pelo qual falhou. |
|
|
docupass_reference
|
docupass_reference | string |
Código de referência para a sessão DocuPass. |
|
|
docupass_success
|
docupass_success | string |
0 ou 1, quer a verificação do DocuPass tenha sido bem-sucedida ou falhada. |
|
|
e-mail
|
string |
Endereço de e-mail do usuário. |
||
|
expiry (expira)
|
expiry | string |
Data de validade (AAAA-MM-DD) |
|
|
eyeColor
|
eyeColor | string |
Cor dos olhos. |
|
|
primeiroNome
|
firstName | string |
Nome próprio |
|
|
firstName_local
|
firstName_local | string |
Nome próprio no idioma local. |
|
|
Nome completo
|
fullName | string |
Nome completo (a atualização de outros campos de nome não atualizará o nome completo) |
|
|
fullName_local
|
fullName_local | string |
Nome próprio no idioma local. |
|
|
Cor de cabelo
|
hairColor | string |
Cor do cabelo. |
|
|
altura
|
height | string |
Altura da pessoa. |
|
|
issueAuthority [en]
|
issueAuthority | string |
Autoridade emissora do documento. |
|
|
emitido
|
issued | string |
Data de emissão (AAAA-MM-DD) |
|
|
issuerOrg_iso2
|
issuerOrg_iso2 | string |
Documento emitido código do país em ISO2. Exemplo: EUA |
|
|
issuerOrg_region_abbr
|
issuerOrg_region_abbr | string |
Sub-região do emissor do documento/abreviatura do estado. Exemplo: CA |
|
|
issuerOrg_region_full
|
issuerOrg_region_full | string |
Sub-região/estado do emissor do documento. Exemplo: Califórnia |
|
|
telefone fixo
|
landline | string |
Número de telefone fixo do usuário. |
|
|
sobrenome
|
lastName | string |
Apelido / Apelido. |
|
|
lastName_local
|
lastName_local | string |
Sobrenome no idioma local. |
|
|
Nome do meio
|
middleName | string |
Nome(s) do meio. |
|
|
middleName_local
|
middleName_local | string |
Nome do meio no idioma local. |
|
|
móvel
|
mobile | string |
Número de telemóvel do utilizador. |
|
|
nationality_iso2
|
nationality_iso2 | string |
Nacionalidade do titular do documento em ISO2. Exemplo: EUA |
|
|
opcionalDados
|
optionalData | string |
Dados adicionais inespecíficos incluídos no documento. |
|
|
opcionalData2
|
optionalData2 | string |
Dados adicionais inespecíficos incluídos no documento. |
|
|
número pessoal
|
personalNumber | string |
Um número identificador secundário no documento. |
|
|
lugarOfBirth
|
placeOfBirth | string |
Local de nascimento. |
|
|
código postal
|
postcode | string |
Código postal do endereço. |
|
|
Restrições
|
restrictions | string |
Restrições de condução. |
|
|
sexo
|
sex | string |
M: Masculino F: Feminino X: Não especificado |
|
|
nível de confiança
|
trustlevel | string |
0: Indeterminado 1: Documento inválido 2: Suspeito 3: Válido Esta pontuação é calculada automaticamente se a autenticação estiver ativada. |
|
|
Nota de confiança
|
trustnote | string | ||
|
vehicleClasse
|
vehicleClass | string |
Classe de veículos na carta de condução. |
|
|
weight
|
weight | string |
Peso da pessoa. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
sucesso
|
success | integer |
Configuração da API principal
API de verificação de ID multifuncional para verificar o documento físico remoto, sua autenticidade e a correspondência facial do documento com sua foto de usuário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível em seu portal da Web. |
|
file_base64
|
file_base64 | string |
Você pode carregar uma imagem codificada em base64 como uma cadeia de caracteres usando application/x-www-form-urlencoded ou application/json. |
|
|
URL
|
url | string |
A API principal é capaz de baixar imagens remotas do seu servidor. |
|
|
file_back_base64
|
file_back_base64 | string |
Imagem codificada em Base64 da parte de trás do documento para executar uma verificação de dois lados. |
|
|
url_back
|
url_back | string |
Imagem remota da parte de trás do documento para executar uma verificação de dois lados. |
|
|
face_base64
|
face_base64 | string |
Imagem codificada em Base64 do rosto de uma pessoa para realizar a verificação biométrica fotográfica. |
|
|
faceurl
|
faceurl | string |
Imagem remota do rosto de uma pessoa para realizar a verificação biométrica fotográfica. |
|
|
video_base64
|
video_base64 | string |
Vídeo selfie codificado em Base64 para realizar verificação biométrica de vídeo. |
|
|
videourl
|
videourl | string |
Vídeo selfie hospedado remotamente para realizar verificação biométrica de vídeo. |
|
|
código de acesso
|
passcode | string |
Número de 4 dígitos |
|
|
precisão
|
accuracy | integer |
Configure a velocidade e a precisão do reconhecimento de documentos e dos resultados de ocr. A baixa precisão reduzirá o tempo de resposta para menos de 1 segundo, enquanto a alta precisão geralmente levará 2 ~ 3 segundos. |
|
|
autenticar
|
authenticate | boolean |
Valide o documento para verificar se ele é autêntico e não foi adulterado. |
|
|
authenticate_module
|
authenticate_module | string |
Especifique o módulo usado para validar o documento. |
|
|
biometric_threshold
|
biometric_threshold | float |
Especificar a pontuação mínima para passar na verificação biométrica facial |
|
|
return_confidence
|
return_confidence | boolean |
Retornar pontuação de confiança para cada campo de dados. |
|
|
return_empty
|
return_empty | boolean |
Você pode obter a API para retornar null em campos vazios habilitando esse parâmetro. |
|
|
ocr_scaledown
|
ocr_scaledown | integer |
Número entre 500 a 4000 ou 0 |
|
|
imagem de saída
|
outputimage | boolean |
Produza uma imagem cortada do documento. |
|
|
outputface
|
outputface | boolean |
Produza uma imagem cortada da região do rosto no documento. |
|
|
Modo de saída
|
outputmode | string |
Saída do documento cortado e face como URL ou conteúdo codificado em base64. |
|
|
verificação dupla lateral
|
dualsidecheck | boolean |
Verifique se os nomes, o número do documento e o tipo de documento correspondem entre a frente e o verso do documento ao executar a verificação frente e verso. Se alguma informação incompatibilizar, o erro 14 será lançado. |
|
|
verify_expiry
|
verify_expiry | boolean |
Verifique se o documento ainda é válido com base na sua data de validade. |
|
|
verify_documentno
|
verify_documentno | string |
Verifique se o número do documento fornecido corresponde ao documento. |
|
|
verify_dob
|
verify_dob | string |
Verifique se a data de nascimento fornecida corresponde ao documento. (AAAA/MM/DD) |
|
|
verify_age
|
verify_age | string |
Verifique se o titular do documento está envelhecido entre o intervalo indicado. (intervalo, exemplo: 18-40) |
|
|
verify_address
|
verify_address | string |
Verifique se o endereço fornecido corresponde ao documento. |
|
|
verify_postcode
|
verify_postcode | string |
Verifique se o código postal fornecido corresponde ao documento. |
|
|
country
|
country | string |
Verifique se o documento foi emitido por países especificados, se não o código de erro 10 será lançado. Separe vários valores com vírgula. Por exemplo, "EUA,CA" aceitaria documentos dos Estados Unidos e Canadá. |
|
|
região
|
region | string |
Verifique se o documento foi emitido pelo estado especificado, se não o código de erro 11 será lançado. Separe vários valores com vírgula. Por exemplo, "CA,TX" aceitaria documentos da Califórnia e do Texas. |
|
|
tipo
|
type | string |
Verifique se o documento era um dos tipos especificados, se não o código de erro 12 será lançado. Por exemplo, "PD" aceitaria passaporte e carteira de motorista. |
|
|
lista de bloqueio de verificação
|
checkblocklist | boolean |
Verifique os dados do documento em relação às entradas bloqueadas no seu cofre. Se o documento corresponder a um dos erros de entrada bloqueados 15 será lançado |
|
|
vault_save
|
vault_save | boolean |
Guarde a imagem do documento e as informações analisadas no seu cofre seguro. Você pode listar, pesquisar e atualizar entradas de documentos em seu cofre por meio da API do Vault ou do portal da Web. |
|
|
vault_saveunrecognized
|
vault_saveunrecognized | boolean |
Guarde a imagem do documento no seu cofre mesmo que o documento não possa ser reconhecido. |
|
|
vault_noduplicate
|
vault_noduplicate | boolean |
Impeça que imagens duplicadas sejam salvas. |
|
|
vault_automerge
|
vault_automerge | boolean |
Mescle automaticamente imagens com o mesmo número de documento em uma única entrada dentro do cofre. |
|
|
vault_customdata1
|
vault_customdata1 | string |
Adicione até 5 strings personalizadas que serão associadas à entrada do vault, isso pode ser útil para filtrar e pesquisar entradas. |
|
|
vault_customdata2
|
vault_customdata2 | string |
Adicione até 5 strings personalizadas que serão associadas à entrada do vault, isso pode ser útil para filtrar e pesquisar entradas. |
|
|
vault_customdata3
|
vault_customdata3 | string |
Adicione até 5 strings personalizadas que serão associadas à entrada do vault, isso pode ser útil para filtrar e pesquisar entradas. |
|
|
vault_customdata4
|
vault_customdata4 | string |
Adicione até 5 strings personalizadas que serão associadas à entrada do vault, isso pode ser útil para filtrar e pesquisar entradas. |
|
|
vault_customdata5
|
vault_customdata5 | string |
Adicione até 5 strings personalizadas que serão associadas à entrada do vault, isso pode ser útil para filtrar e pesquisar entradas. |
|
|
aml_check
|
aml_check | boolean |
Verifique o nome e o número do documento do titular do documento no banco de dados AML do ID Analyzer. |
|
|
aml_database
|
aml_database | string |
Separe cada código de banco de dados com vírgula, por exemplo: un_sc,us_ofac. |
|
|
aml_strict_match
|
aml_strict_match | boolean |
Habilite esse parâmetro para reduzir falsos positivos combinando apenas entidades com exatamente a mesma nacionalidade e aniversário. |
|
|
contract_generate
|
contract_generate | string |
ID do modelo de contrato para preenchimento automático com dados do usuário. |
|
|
contract_format
|
contract_format | string |
Formato do documento de saída. Opcionais: PDF, DOCX, HTML. |
|
|
contract_prefill_data
|
contract_prefill_data | object |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Número do documento
|
result.documentNumber | string |
Identificador único associado ao documento (por exemplo, n.º do passaporte/n.º da carta de condução/número do cartão, etc.) |
|
número pessoal
|
result.personalNumber | string |
Identificador pessoal único associado à pessoa num país (por exemplo, número de identificação nacional) |
|
primeiroNome
|
result.firstName | string |
Nome próprio |
|
sobrenome
|
result.lastName | string |
Apelido / Apelido |
|
Nome do meio
|
result.middleName | string |
Nome(s) do meio |
|
Nome completo
|
result.fullName | string |
Se o nome e o sobrenome não puderem ser distinguidos, o nome completo será retornado |
|
firstName_local
|
result.firstName_local | string |
Nome próprio no idioma local, se disponível |
|
lastName_local
|
result.lastName_local | string |
Sobrenome no idioma local, se disponível |
|
middleName_local
|
result.middleName_local | string |
Nome do meio no idioma local, se disponível |
|
fullName_local
|
result.fullName_local | string |
Nome completo no idioma local, se disponível |
|
sexo
|
result.sex | string |
Sexo M=Masculino F=Feminino X=Não especificado |
|
altura
|
result.height | string |
Altura da pessoa |
|
weight
|
result.weight | string |
Peso da pessoa |
|
Cor de cabelo
|
result.hairColor | string |
Cor do cabelo - ANSI D-20 código de cor do cabelo (3 letras) |
|
eyeColor
|
result.eyeColor | string |
Cor dos olhos - ANSI D-20 código de cor dos olhos (3 letras) |
|
idade
|
result.age | integer |
Idade do titular do documento |
|
DOB
|
result.dob | string |
Data de nascimento em AAAA/MM/DD |
|
dob_day
|
result.dob_day | integer |
Data de nascimento dia 1 a 31 |
|
dob_month
|
result.dob_month | integer |
Data de nascimento: mês 1 a 12 |
|
dob_year
|
result.dob_year | integer |
Data do ano de nascimento em AAAA |
|
expiry (expira)
|
result.expiry | string |
Data de validade do documento em AAAA/MM/DD |
|
expiry_day
|
result.expiry_day | integer |
Dia do prazo de validade 1 a 31 |
|
expiry_month
|
result.expiry_month | integer |
Mês de validade 1 a 12 |
|
expiry_year
|
result.expiry_year | integer |
Ano de validade em AAAA |
|
diasatéExpiração
|
result.daysToExpiry | integer |
Número de dias antes de o documento expirar |
|
emitido
|
result.issued | string |
Data de emissão em AAAA/MM/DD |
|
issued_day
|
result.issued_day | integer |
Dia da edição 1 a 31 |
|
issued_month
|
result.issued_month | integer |
Mês de emissão 1 a 12 |
|
issued_year
|
result.issued_year | integer |
Ano de emissão em AAAA |
|
diasFromIssue
|
result.daysFromIssue | integer |
Número de dias decorridos desde a emissão do documento |
|
Endereço1
|
result.address1 | string |
Linha 1 do endereço |
|
Endereço2
|
result.address2 | string |
Linha de endereço 2 |
|
código postal
|
result.postcode | string |
Código postal do endereço |
|
lugarOfBirth
|
result.placeOfBirth | string |
Local de nascimento |
|
vehicleClasse
|
result.vehicleClass | string |
Classe de veículo com carta de condução |
|
Restrições
|
result.restrictions | string |
Restrições da carta de condução |
|
endosso
|
result.endorsement | string |
Endosso da carteira de motorista |
|
opcionalDados
|
result.optionalData | string |
Dados adicionais inespecíficos incluídos no documento |
|
opcionalData2
|
result.optionalData2 | string |
Dados adicionais inespecíficos incluídos no documento |
|
Tipo de documento
|
result.documentType | string |
Tipo de documento: P=Passaporte, D=Carta de Condução, I=Bilhete de Identidade, V=Visa, R=Cartão de Residência, O=Outro |
|
documentSide
|
result.documentSide | string |
Lado do documento: FRENTE, VERSO ou BIODATA |
|
issuerOrg_region_full
|
result.issuerOrg_region_full | string |
Sub-região/estado do emissor do documento. (por exemplo, Califórnia) |
|
issuerOrg_region_abbr
|
result.issuerOrg_region_abbr | string |
Sub-região do emissor do documento/abreviatura do estado. (por exemplo, AC) |
|
issuerOrg_full
|
result.issuerOrg_full | string |
País de emissão do documento. (por exemplo, Estados Unidos) |
|
issuerOrg_iso2
|
result.issuerOrg_iso2 | string |
Documento emitido código do país em ISO2. (por exemplo, EUA) |
|
issuerOrg_iso3
|
result.issuerOrg_iso3 | string |
Documento emitido código de país em ISO3. (por exemplo, EUA) |
|
nationality_full
|
result.nationality_full | string |
Nacionalidade do titular do documento. (por exemplo, Estados Unidos) |
|
nationality_iso2
|
result.nationality_iso2 | string |
Nacionalidade do titular do documento em ISO2. (por exemplo, EUA) |
|
nationality_iso3
|
result.nationality_iso3 | string |
Nacionalidade do titular do documento em ISO3. (por exemplo, EUA) |
|
Id interno
|
result.internalId | string |
Usado para identificar o ID de documento exclusivo no sistema ID Analyzer, o mesmo tipo de documento deve ter o mesmo ID. |
|
Número do documento
|
confidence.documentNumber | float |
nível de confiança do documentoNúmero |
|
primeiroNome
|
confidence.firstName | float |
nível de confiança do firstName |
|
sobrenome
|
confidence.lastName | float |
nível de confiança do apelido/apelido |
|
Nome do meio
|
confidence.middleName | float |
nível de confiança do(s) Nome(s) do Meio(s) |
|
dob_month
|
confidence.dob_month | float |
nível de confiança dos dob_month |
|
dob_day
|
confidence.dob_day | float |
nível de confiança dos dob_day |
|
dob_year
|
confidence.dob_year | float |
nível de confiança dos dob_year |
|
issued_month
|
confidence.issued_month | float |
nível de confiança dos issued_month |
|
issued_day
|
confidence.issued_day | float |
nível de confiança dos issued_day |
|
issued_year
|
confidence.issued_year | float |
nível de confiança dos issued_year |
|
expiry_month
|
confidence.expiry_month | float |
nível de confiança dos expiry_month |
|
expiry_day
|
confidence.expiry_day | float |
nível de confiança dos expiry_day |
|
expiry_year
|
confidence.expiry_year | float |
nível de confiança dos expiry_year |
|
sexo
|
confidence.sex | float |
nível de confiança do sexo |
|
altura
|
confidence.height | float |
nível de confiança da altura |
|
weight
|
confidence.weight | float |
nível de confiança do peso |
|
Endereço1
|
confidence.address1 | float |
nível de confiança do endereço1 |
|
Endereço2
|
confidence.address2 | float |
nível de confiança do endereço2 |
|
código postal
|
confidence.postcode | float |
nível de confiança do código postal |
|
vehicleClasse
|
confidence.vehicleClass | float |
nível de confiança do vehicleClass |
|
Restrições
|
confidence.restrictions | float |
nível de confiança das restrições |
|
endosso
|
confidence.endorsement | float |
nível de confiança da aprovação |
|
eyeColor
|
confidence.eyeColor | float |
nível de confiança do eyeColor |
|
idade
|
confidence.age | float |
nível de confiança da idade |
|
DOB
|
confidence.dob | float |
nível de confiança da dob |
|
diasatéExpiração
|
confidence.daysToExpiry | float |
nível de confiança de diasParaExpiração |
|
expiry (expira)
|
confidence.expiry | float |
nível de confiança da expiração |
|
emitido
|
confidence.issued | float |
nível de confiança dos emitidos |
|
diasFromIssue
|
confidence.daysFromIssue | float |
nível de confiança dos diasFromIssue |
|
Nome completo
|
confidence.fullName | float |
nível de confiança de fullName |
|
isIdêntico
|
face.isIdentical | boolean |
Verificação biométrica aprovada ou reprovada |
|
confiança
|
face.confidence | string |
Valor entre 0 a 1 sobre a semelhança das duas faces, sendo 1 idêntico. |
|
erro
|
face.error | integer |
Código de Erro |
|
error_message
|
face.error_message | string |
Mensagem de erro. Exemplo: Não foi possível encontrar dados faciais na imagem facial |
|
aprovado
|
verification.passed | boolean |
Se o documento tiver passado por todas as verificações, retornará verdadeiro. Se o documento tiver falhado pelo menos um tipo de verificação, retornará false. |
|
rosto
|
verification.result.face | boolean |
Se a verificação biométrica estiver habilitada, se a pontuação de confiança de similaridade estiver acima do limite definido. |
|
não expirou
|
verification.result.notexpired | boolean |
Se o documento ainda não expirou. |
|
nome
|
verification.result.name | boolean |
Se o nome fornecido corresponde ao nome analisado a partir da ID. |
|
DOB
|
verification.result.dob | boolean |
Se o aniversário fornecido correspondia ao aniversário analisado a partir do ID. |
|
Número do documento
|
verification.result.documentNumber | boolean |
Se o número do documento fornecido corresponde ao número do documento analisado a partir do ID. |
|
código postal
|
verification.result.postcode | boolean |
Se o código postal fornecido corresponde ao código postal analisado a partir do ID. |
|
address
|
verification.result.address | boolean |
Se o endereço fornecido corresponde ao endereço analisado a partir da ID. |
|
dígito de verificação
|
verification.result.checkdigit | boolean |
Se o tipo de documento tiver um algoritmo de dígito de verificação/soundex, se os dígitos de verificação são válidos. |
|
idade
|
verification.result.age | boolean |
Se o titular do documento está dentro da faixa etária definida. |
|
cccode
|
verification.result.cccode | boolean |
Se o tipo de documento tiver implementação de código comercial chinês (código CC), se os códigos CC são válidos. |
|
classificação
|
authentication.score | float |
O placar oscilará entre 0 a 1. Os documentos válidos terão uma pontuação mais próxima de 1, enquanto os documentos falsos ou editados terão uma pontuação mais próxima de 0. É sua discrição decidir o limite, um bom ponto de partida seria rejeitar pontuação inferior a 0,5 |
|
aprovado
|
authentication.breakdown.data_visibility.passed | boolean | |
|
aprovado
|
authentication.breakdown.image_quality.passed | boolean | |
|
aprovado
|
authentication.breakdown.feature_referencing.passed | boolean | |
|
aprovado
|
authentication.breakdown.exif_check.passed | boolean | |
|
código
|
authentication.breakdown.exif_check.code | integer | |
|
razão
|
authentication.breakdown.exif_check.reason | string | |
|
severity
|
authentication.breakdown.exif_check.severity | string | |
|
aprovado
|
authentication.breakdown.publicity_check.passed | boolean | |
|
código
|
authentication.breakdown.publicity_check.code | integer | |
|
razão
|
authentication.breakdown.publicity_check.reason | string | |
|
severity
|
authentication.breakdown.publicity_check.severity | string | |
|
aprovado
|
authentication.breakdown.text_analysis.passed | boolean | |
|
aprovado
|
authentication.breakdown.biometric_analysis.passed | boolean | |
|
aprovado
|
authentication.breakdown.security_feature_check.passed | boolean | |
|
código
|
authentication.breakdown.security_feature_check.code | integer | |
|
razão
|
authentication.breakdown.security_feature_check.reason | string | |
|
severity
|
authentication.breakdown.security_feature_check.severity | string | |
|
aprovado
|
authentication.breakdown.recapture_check.passed | boolean | |
|
código
|
authentication.breakdown.recapture_check.code | integer | |
|
razão
|
authentication.breakdown.recapture_check.reason | string | |
|
severity
|
authentication.breakdown.recapture_check.severity | string | |
|
aviso
|
authentication.warning | array of string |
Matriz de cadeia de caracteres contendo mensagens de aviso sobre a validade do documento. |
|
LMA
|
aml | array of object |
Array contendo lista de correspondências AML, retorna uma matriz vazia se nenhuma correspondência foi encontrada. Para obter detalhes específicos, consulte AML API Reference. |
|
entidade
|
aml.entity | string |
pessoa física ou jurídica |
|
nome completo
|
aml.fullname | array of string |
Nome(s) da(s) pessoa(s) coletiva(s) |
|
Nome próprio
|
aml.firstname | array of string |
Nome(s) próprio(s) |
|
Apelido
|
aml.lastname | array of string |
Apelido(s) da pessoa |
|
nome do meio
|
aml.middlename | array of string |
Nome(s) do meio(s) da pessoa |
|
alias
|
aml.alias | array of string |
Nome(s) alternativo(s) ou estrangeiro(s) da entidade |
|
DOB
|
aml.dob | array of string |
O aniversário de Peron pode vir nos formatos AAAA, AAAA-MM ou AAAA-MM-DD. |
|
address
|
aml.address | array of string |
Endereço ou país de residência da entidade |
|
nacionalidade
|
aml.nationality | array of string |
País ou nacionalidade da entidade |
|
local de nascimento
|
aml.birthplace | array of string |
Local de nascimento de Perón |
|
Género
|
aml.gender | array of string |
Sexo de Perón: M ou F |
|
número do documento
|
aml.documentnumber | array of object |
Uma lista de documentos associados à entidade. |
|
id
|
aml.documentnumber.id | string |
Número do documento |
|
id_formatted
|
aml.documentnumber.id_formatted | string |
Número alfanumérico do documento |
|
country
|
aml.documentnumber.country | string |
Código do país ISO2 |
|
tipo
|
aml.documentnumber.type | string |
P = Número de passaporte, I = Número de identificação, D = Número da carta de condução, O = Outro/Tipo de documento desconhecido |
|
programa
|
aml.program | array of string |
Programa(s) sancionatório(s) |
|
Observação
|
aml.note | array of string |
Nota adicional para a entidade |
|
time
|
aml.time | string |
Carimbo de data/hora UTC TZ quando a entidade foi adicionada à lista de fontes ou atualizada pela última vez |
|
estado
|
aml.status | string |
Cargo/título da entidade ou situação atual da sanção |
|
origem
|
aml.source | array of string |
Uma lista de URL(s) de origem oficial |
|
base de dados
|
aml.database | string |
Código do banco de dados AML do ID Analyzer |
|
esquema
|
aml.schema | string | |
|
document_url
|
contract.document_url | string |
URL para o documento gerado |
|
erro
|
contract.error | string |
Caso o contrato não tenha sido gerado, este campo conterá motivos como "ID do modelo de contrato inválido". |
|
Vaultid
|
vaultid | string |
Identificador exclusivo para a entrada do cofre se vault_save estiver habilitado. |
|
taxa de correspondência
|
matchrate | float |
A proporção de campos reconhecidos com êxito pela API, uma proporção baixa indicaria que a imagem do documento está muito desfocada. |
|
output
|
output | string |
Se outputimage estiver definido como true e outputmode for url, este campo incluirá um URL (ou uma matriz de URLs para verificação dualside) apontando para a imagem cortada do documento. O link só tem garantia de vida por 600 segundos e será removido a qualquer momento depois. |
|
outputface
|
outputface | string |
Se outputface estiver definido como true e outputmode for url, este campo incluirá um URL apontando para a imagem de face cortada. O link só tem garantia de vida por 600 segundos e será removido a qualquer momento depois. |
|
cortado
|
cropped | string |
Se outputimage estiver definido como true e outputmode for base64, este campo incluirá uma imagem codificada em base64 (ou uma matriz de imagens codificadas em base64 para digitalização dualside) de documento cortado em formato JPEG |
|
cara cortada
|
croppedface | string |
Se outputface estiver definido como true e outputmode for base64, este campo incluirá uma imagem codificada em base64 da região da face cortada do documento em formato JPEG |
|
executionTime
|
executionTime | float |
Tempo necessário para a operação da API em segundos. |
|
responseID
|
responseID | string |
Um identificador exclusivo para identificar a solicitação/resposta. |
|
quota
|
quota | integer |
Quota de API restante, redefinições no início de cada mês para subscritor gratuito ou anual, ou no início de cada ciclo de faturação para subscritor mensal. Se tiver um plano de subscrição, a sua quota mensal será utilizada antes do crédito. |
|
crédito
|
credit | integer |
Crédito de teste restante para a sua conta. Se tiver um plano de subscrição, a sua quota mensal será utilizada antes do crédito. |
Criando sessão de assinatura do DocuPass
Você pode criar uma sessão de assinatura em que o usuário revisará e assinará o documento legal sem verificação de identidade. Se você quiser realizar a verificação de identidade e fazer com que seu usuário assine algum documento, crie uma sessão de verificação de identidade.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível em seu portal da Web. |
|
nome da empresa
|
companyname | True | string |
O nome da sua empresa será exibido em toda a página de verificação para que o usuário final saiba que está enviando informações de identidade para sua empresa |
|
template_id
|
template_id | string |
ID do modelo de contrato para preenchimento automático com dados do usuário. |
|
|
contract_format
|
contract_format | string |
Formato do documento de saída. (PDF, DOCX, HTML) |
|
|
callbackurl
|
callbackurl | string |
O ficheiro do contrato será enviado para este url. Você deve habilitar vault_save ou especificar um callbackurl para que possa salvar o documento gerado. |
|
|
successredir
|
successredir | string |
O navegador será redirecionado para este URL depois que o documento for revisado e assinado. O código de referência e customid do DocuPass serão anexados ao final do URL |
|
|
customid
|
customid | string |
Uma cadeia de caracteres personalizada que será enviada de volta para a URL de retorno de chamada do servidor e anexada às URLs de redirecionamento definidas por successredir e failredir como uma cadeia de caracteres de consulta. É útil para identificar o seu utilizador na sua base de dados. Esse valor será armazenado em docupass_customid no Vault. |
|
|
reutilizável
|
reusable | boolean |
Nabling este parâmetro permitirá que vários usuários revisem e assinem documentos através da mesma URL, um novo código de referência DocuPass será gerado para cada usuário automaticamente. |
|
|
sms_contract_link
|
sms_contract_link | string |
Número de telemóvel internacional completo |
|
|
vault_save
|
vault_save | boolean |
Salve o documento gerado no vault. Você deve habilitar vault_save ou especificar um callbackurl para que possa salvar o documento gerado. |
|
|
NoBranding
|
nobranding | boolean |
Oculte o logotipo da marca em todas as páginas do DocuPass. |
|
|
customhtmlurl
|
customhtmlurl | string |
Use sua própria página HTML e CSS para DocuPass. Depois de fazer alterações no HTML e CSS, você precisa carregá-los para o seu próprio servidor, no início de cada sessão, o DocuPass baixará a página HTML mais recente do seu servidor. |
|
|
linguagem
|
language | string |
O DocuPass deteta automaticamente o idioma do dispositivo do usuário e exibe o idioma correspondente. Defina este parâmetro para substituir a deteção automática de idioma. (en, fr, nl, de, es, zh-TW, zh-CN) |
|
|
expiry (expira)
|
expiry | integer |
Número de segundos antes da sessão DocuPass expirar. Após o vencimento, o usuário não poderá continuar com a sessão atual, um retorno de chamada com falha também será enviado. |
|
|
qr_color
|
qr_color | string |
Cor do primeiro plano do QR Code |
|
|
qr_bgcolor
|
qr_bgcolor | string |
Cor do fundo do QR Code |
|
|
qr_size
|
qr_size | integer |
Tamanho do QR Code |
|
|
qr_margin
|
qr_margin | integer |
Espessura da borda do QR Code |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
referenciar
|
reference | string |
Um código de referência exclusivo para a sessão DocuPass. |
|
customid
|
customid | string |
ID personalizada usada ao criar a sessão DocuPass. |
|
URL
|
url | string |
URL exclusivo para o aplicativo Web DocuPass. Envie este link para seu usuário ou incorpore-o ao seu site ou aplicativo móvel para revisar e assinar o documento. |
|
qrcode
|
qrcode | string |
URL da imagem do código QR para o seu utilizador digitalizar |
|
base_url
|
base_url | string |
Pode enviar esta ligação ao seu utilizador e pedir-lhe que introduza o código de referência para assinar documentos. |
|
html_qrcode
|
html_qrcode | string |
Exemplo de HTML para exibir QR Code em sua página da Web. |
|
html_iframe
|
html_iframe | string |
Exemplo de HTML para inserir iframe em sua página da Web. |
|
SMSSENT
|
smssent | string |
Contém o número de telefone como confirmação quando o SMS foi enviado com sucesso através sms_contract_link parâmetro. |
|
expiry (expira)
|
expiry | integer |
Carimbo de data/hora UTC UNIX indicando quando esta sessão expirará, após o vencimento, o usuário não poderá mais usar o link e um retorno de chamada com falha será enviado. |
Criando sessão DocuPass
Você pode criar uma sessão de verificação para cada usuário que precise de verificação de identidade.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível em seu portal da Web. |
|
tipo
|
type | integer |
0: Módulo Iframe, 1: Módulo Móvel, 2: Módulo de Redireccionamento, 3: Módulo Live Mobile |
|
|
nome da empresa
|
companyname | True | string |
Nome da sua empresa ou produto. |
|
callbackurl
|
callbackurl | string |
Webhook/URL de retorno de chamada para receber o resultado da verificação. |
|
|
biométrica
|
biometric | integer |
Peça ao usuário para tirar uma foto selfie ou um vídeo selfie para verificação facial. |
|
|
biometric_threshold
|
biometric_threshold | float |
Especificar a pontuação mínima para passar na verificação biométrica facial |
|
|
authenticate_minscore
|
authenticate_minscore | float |
O documento deve atender à pontuação mínima de autenticidade para ser aprovado na validação. Defina 0 para desativar a verificação de validade/autenticidade. |
|
|
authenticate_module
|
authenticate_module | integer |
Especifique o módulo usado para validar o documento. |
|
|
MaxAttempt
|
maxattempt | integer |
O número máximo de tentativas de falha para cada solicitação de verificação. |
|
|
successredir
|
successredir | string |
O navegador será redirecionado para este URL quando a verificação de identidade for bem-sucedida. |
|
|
Failredir
|
failredir | string |
O navegador será redirecionado para este URL quando a verificação de identidade falhar. |
|
|
customid
|
customid | string |
É útil para identificar o seu utilizador na sua base de dados. Esse valor será armazenado em docupass_customid no Vault. |
|
|
reutilizável
|
reusable | boolean |
Habilitar esse parâmetro permitirá que vários usuários verifiquem sua identidade através da mesma URL, um novo código de referência do DocuPass será gerado para cada usuário automaticamente. |
|
|
PhoneVerification
|
phoneverification | boolean |
Se pedir ao usuário para inserir um número de telefone para verificação, o DocuPass suporta a verificação de números de telefone celular ou fixo. (Apenas assinante) |
|
|
tipo de documento
|
documenttype | string |
O usuário deve carregar um tipo específico de documento. Por exemplo, "PD" aceitaria passaporte e carteira de motorista. |
|
|
documentopaís
|
documentcountry | string |
Código ISO ALPHA-2 do país. |
|
|
região do documento
|
documentregion | string |
Nome completo ou abreviatura do Estado/Região. |
|
|
verificação dupla lateral
|
dualsidecheck | boolean |
Verifique se os nomes, o número do documento e o tipo de documento correspondem entre a frente e o verso do documento ao executar a verificação frente e verso. Se alguma informação incompatibilizar, o erro 14 será lançado. |
|
|
verify_expiry
|
verify_expiry | boolean |
Aceitar apenas documento que não tenha expirado |
|
|
verify_documentno
|
verify_documentno | string |
Número do documento que necessita de verificação. |
|
|
verify_name
|
verify_name | string |
Nome completo, incluindo nome próprio e apelido que requerem verificação. |
|
|
verify_dob
|
verify_dob | string |
Data de nascimento que requer verificação, no formato AAAA/MM/DD. |
|
|
verify_age
|
verify_age | string |
Faixa etária, exemplo: 18-40 |
|
|
verify_address
|
verify_address | string |
Endereço completo que requer verificação. |
|
|
verify_postcode
|
verify_postcode | string |
Código postal completo a ser verificado. |
|
|
verify_phone
|
verify_phone | string |
Número de telefone completo que requer verificação. |
|
|
vault_save
|
vault_save | boolean |
Salve documentos do usuário e informações analisadas no vault. |
|
|
return_documentimage
|
return_documentimage | boolean |
Imagem de documento de retorno carregada pelo usuário na solicitação de retorno de chamada. |
|
|
return_faceimage
|
return_faceimage | boolean |
Retornar imagem de rosto carregada pelo usuário na solicitação de retorno de chamada. |
|
|
return_type
|
return_type | integer |
Especifique o tipo de imagem que está sendo retornada, seja o conteúdo da imagem codificada em base64 ou uma URL para a imagem. (URL da imagem será mantido por apenas 7 dias) |
|
|
mensagem de boas-vindas
|
welcomemessage | string |
Substitua a mensagem de saudação genérica na primeira página pelo texto personalizado (máx. 1.000 caracteres) |
|
|
NoBranding
|
nobranding | boolean |
Oculte o logotipo da marca em todas as páginas do DocuPass. (Apenas assinante) |
|
|
logótipo
|
logo | string |
Logótipo de marca personalizado. (Apenas assinante) |
|
|
customhtmlurl
|
customhtmlurl | string |
Use sua própria página HTML e CSS para DocuPass. (Apenas assinante) |
|
|
linguagem
|
language | string |
O DocuPass deteta automaticamente o idioma do dispositivo do usuário e exibe o idioma correspondente. |
|
|
expiry (expira)
|
expiry | integer |
Número de segundos antes da sessão DocuPass expirar. Após o vencimento, o usuário não poderá continuar com a sessão atual, um retorno de chamada com falha também será enviado. |
|
|
qr_color
|
qr_color | string |
Cor do primeiro plano do código QR. (Apenas para Live Mobile e Standard Mobile) |
|
|
qr_bgcolor
|
qr_bgcolor | string |
Cor do fundo do QR Code. (Apenas para Live Mobile e Standard Mobile) |
|
|
qr_size
|
qr_size | integer |
Tamanho do QR Code(1-50). (Apenas para Live Mobile e Standard Mobile) |
|
|
qr_margin
|
qr_margin | integer |
Espessura da borda do QR Code(1-50). (Apenas para Live Mobile e Standard Mobile) |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
referenciar
|
reference | string |
Um código de referência exclusivo para a sessão DocuPass. |
|
tipo
|
type | integer |
Tipo de módulo DocuPass criado. |
|
customid
|
customid | string |
ID personalizada usada ao criar a sessão DocuPass. |
|
URL
|
url | string |
URL exclusivo para o aplicativo Web DocuPass. Envie este link para seu usuário ou incorpore-o ao seu site ou aplicativo móvel para iniciar a verificação de identidade. |
|
qrcode
|
qrcode | string |
URL da imagem do código QR para o seu utilizador digitalizar |
|
base_url
|
base_url | string |
Você pode enviar este link para o seu usuário e pedir-lhe para inserir o código de referência para iniciar a verificação. |
|
html
|
html | string |
Exemplo de HTML que você pode inserir em sua página da Web. |
|
SMSSENT
|
smssent | integer |
Contém o número de telefone como confirmação quando o SMS foi enviado com sucesso através sms_verification_link parâmetro. |
|
expiry (expira)
|
expiry | integer |
Carimbo de data/hora UTC UNIX indicando quando esta sessão expirará, após o vencimento, o usuário não poderá mais usar o link e um retorno de chamada com falha será enviado. |
Estado da Formação
Verifique se o treinamento do vault ainda está em andamento ou foi concluído.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível em seu Portal da Web. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
estado
|
status | string |
nottreinado: Nunca treinado, não iniciado: Treinamento não está correndo, correndo: O treinamento está atualmente em execução, bem-sucedido: Treinamento bem-sucedido, reprovado: Treinamento falhou |
|
startTime
|
startTime | string |
Hora em que o último treino foi iniciado em UTC. |
|
statusChangeTime
|
statusChangeTime | string |
Hora da última alteração de status em UTC. |
|
lastSuccessTime
|
lastSuccessTime | string |
Hora do último treino bem-sucedido em UTC. |
|
erro
|
error | string |
Mensagem de erro associada ao status de treinamento com falha. |
Excluir entrada do Vault
Você pode excluir uma ou várias entradas do cofre fazendo uma solicitação HTTP POST.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível em seu Portal da Web. |
|
id
|
id | True | array of string |
id |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
sucesso
|
success | integer |
Excluir imagem do Vault
Você pode excluir uma imagem dentro de uma entrada do cofre fazendo uma solicitação HTTP POST. Observe que, depois que uma imagem é excluída, o URL para a imagem ainda pode estar acessível por um curto período de tempo devido ao cache.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível em seu Portal da Web. |
|
id
|
id | True | string |
Identificador de entrada do cofre que contém a imagem. |
|
imageid
|
imageid | string |
id da imagem a eliminar. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
sucesso
|
success | integer |
Listar e filtrar entradas
Para listar todas as entradas armazenadas dentro do cofre ou procurar entradas com valores específicos, envie uma solicitação HTTP POST para o ponto de extremidade a seguir.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível em seu Portal da Web. |
|
encomendado por
|
orderby | string |
Nome do campo utilizado para ordenar o resultado. |
|
|
ordenar
|
sort | string |
ASC para classificar resultados em ordem crescente, DESC para classificar em ordem decrescente. |
|
|
limit
|
limit | integer |
Número de entradas do cofre a serem retornadas. (1 a 100) |
|
|
offset
|
offset | integer |
Lista de retorno a partir de uma entrada específica, por exemplo, quando limit=10, para acessar a terceira página dos resultados, use offset=20 |
|
|
filtro
|
filter | array of string |
filtro |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
limit
|
limit | integer |
Limite atual |
|
offset
|
offset | integer |
Deslocamento atual |
|
PróximoOffset
|
nextoffset | integer |
Valor de deslocamento para o próximo conjunto de dados. Se o conjunto de dados atual for o conjunto final de dados, este campo não será retornado. |
|
total
|
total | integer |
Número total de entradas encontradas. |
|
items
|
items | array of |
Uma matriz de entradas encontradas e seu conteúdo completo, idêntico ao conteúdo retornado pelo método GET. |
Obter conteúdo de entrada do Vault
Quando as entradas são adicionadas ao vault, tanto a API Core quanto a API DocuPass retornarão um identificador de entrada do vault chamado vaultid. Você pode usar o identificador para consultar o conteúdo de uma entrada no cofre enviando uma solicitação HTTP POST para o ponto de extremidade a seguir.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível em seu Portal da Web. |
|
id
|
id | string |
Identificador de entrada do cofre. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
sucesso
|
success | integer | |
|
id
|
data.id | string |
Identificador de entrada do cofre |
|
CreateTime
|
data.createtime | string |
Carimbo de data/hora da criação da entrada em UTC |
|
Tempo de atualização
|
data.updatetime | string |
Carimbo de data/hora da última modificação em UTC |
|
nível de confiança
|
data.trustlevel | string |
Essa pontuação é calculada automaticamente se a autenticação estiver habilitada. (0: Indeterminado, 1: Documento inválido, 2: Suspeito, 3: Válido) |
|
Nota de confiança
|
data.trustnote | string |
Avisos associados à validade do documento. |
|
docupass_reference
|
data.docupass_reference | string |
Código de referência para a sessão DocuPass |
|
docupass_success
|
data.docupass_success | string |
0 ou 1, quer a verificação do DocuPass tenha sido bem-sucedida ou falhada. |
|
docupass_failedreason
|
data.docupass_failedreason | string |
Se a verificação do DocuPass falhou, o motivo pelo qual falhou. |
|
docupass_customid
|
data.docupass_customid | string |
customid passado ao criar a verificação DocuPass. |
|
Número do documento
|
data.documentNumber | string |
O identificador único do documento (N.º do Passaporte/N.º da Carta de Condução, etc.) |
|
documentNumber_formatted
|
data.documentNumber_formatted | string |
Cadeia de caracteres gerada automaticamente de documentNumber sem quaisquer símbolos, este campo é útil para filtrar resultados. |
|
número pessoal
|
data.personalNumber | string |
Um número identificador secundário no documento |
|
primeiroNome
|
data.firstName | string |
Nome próprio |
|
Nome do meio
|
data.middleName | string |
Nome(s) do meio |
|
sobrenome
|
data.lastName | string |
Apelido / Apelido |
|
Nome completo
|
data.fullName | string |
Nome completo (a atualização de outros campos de nome não atualizará o nome completo) |
|
firstName_local
|
data.firstName_local | string |
Nome próprio no idioma local |
|
middleName_local
|
data.middleName_local | string |
Nome do meio no idioma local |
|
lastName_local
|
data.lastName_local | string |
Sobrenome no idioma local |
|
fullName_local
|
data.fullName_local | string |
Nome completo no idioma local |
|
DOB
|
data.dob | string |
Data de nascimento |
|
emitido
|
data.issued | string |
Data de emissão |
|
expiry (expira)
|
data.expiry | string |
Data de expiração |
|
sexo
|
data.sex | string |
M: Masculino, F: Feminino, X: Não especificado |
|
altura
|
data.height | string |
Altura da pessoa |
|
weight
|
data.weight | string |
Peso da pessoa |
|
Cor de cabelo
|
data.hairColor | string |
Cor do cabelo |
|
eyeColor
|
data.eyeColor | string |
Cor dos olhos |
|
Endereço1
|
data.address1 | string |
Linha 1 do endereço |
|
Endereço2
|
data.address2 | string |
Linha de endereço 2 |
|
código postal
|
data.postcode | string |
Código postal do endereço |
|
lugarOfBirth
|
data.placeOfBirth | string |
Local de nascimento |
|
Tipo de documento
|
data.documentType | string |
P: Passaporte, D: Carta de Condução, I: Bilhete de Identidade, V: Visa, R: Cartão de Residência, O: Outros |
|
Nome do documento
|
data.documentName | string |
Nome do documento |
|
vehicleClasse
|
data.vehicleClass | string |
Classe de veículos na carta de condução |
|
Restrições
|
data.restrictions | string |
Restrições de circulação |
|
endosso
|
data.endorsement | string |
Endosso da carteira de motorista |
|
e-mail
|
data.email | string |
Endereço de e-mail do usuário |
|
móvel
|
data.mobile | string |
Número de telemóvel do utilizador |
|
telefone fixo
|
data.landline | string |
Número de telefone fixo do usuário |
|
issueAuthority [en]
|
data.issueAuthority | string |
Autoridade emissora do documento |
|
issuerOrg_region_full
|
data.issuerOrg_region_full | string |
Sub-região/estado do emissor do documento. Exemplo: Califórnia |
|
issuerOrg_region_abbr
|
data.issuerOrg_region_abbr | string |
Sub-região do emissor do documento/abreviatura do estado. Exemplo: CA |
|
issuerOrg_iso2
|
data.issuerOrg_iso2 | string |
Documento emitido código do país em ISO2. Exemplo: EUA |
|
nationality_iso2
|
data.nationality_iso2 | string |
Nacionalidade do titular do documento em ISO2. Exemplo: EUA |
|
opcionalDados
|
data.optionalData | string |
Dados adicionais inespecíficos incluídos no documento |
|
opcionalData2
|
data.optionalData2 | string |
Dados adicionais inespecíficos incluídos no documento |
|
dados personalizados1
|
data.customdata1 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada |
|
dados personalizados2
|
data.customdata2 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada |
|
dados personalizados3
|
data.customdata3 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada |
|
dados personalizados4
|
data.customdata4 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada |
|
dados personalizados5
|
data.customdata5 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada |
|
bloco
|
data.block | string |
Defina esse parâmetro para impedir que o mesmo documento seja enviado à API principal ou ao DocuPass. |
|
contrato
|
data.contract | string |
Link para documentos contratuais ou legais gerados/assinados usando a API principal ou o DocuPass |
|
imagem
|
data.image | array of object |
Contém uma lista de imagens associadas à entrada. |
|
id
|
data.image.id | string |
Identificador de imagem |
|
tipo
|
data.image.type | string |
0 para documento e 1 para pessoa |
|
hash
|
data.image.hash | string |
Hash MD5 da imagem |
|
URL
|
data.image.url | string |
URL para a imagem |
|
CreateTime
|
data.image.createtime | string |
A imagem da hora foi carregada em UTC |
Pesquisa de rostos
A pesquisa facial permite-lhe pesquisar todo o cofre utilizando uma imagem de uma pessoa. Para usar o recurso de pesquisa de rosto, você deve habilitar a indexação de pesquisa de rosto no portal da Web e treinar seus conjuntos de dados do cofre periodicamente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível em seu Portal da Web. |
|
imagem
|
image | string |
Dados de imagem codificados em Base64. |
|
|
imageurl
|
imageurl | string |
URL de imagem remota. |
|
|
Entrada máxima
|
maxentry | integer |
Número de entradas correspondentes a serem devolvidas, entre 1 e 10. |
|
|
limiar
|
threshold | float |
Defina a pontuação mínima de similaridade facial necessária, na faixa de 0 a 1. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of |
Se forem encontradas entradas correspondentes, será devolvida uma lista de documentos com conteúdo completo semelhante ao comando list. |
Pesquisando banco de dados AML
A API AML permite pesquisar o banco de dados AML global do ID Analyzer para sanções, PEPs e criminosos procurados usando um nome, número de documento ou ambos. Pode ainda filtrar os resultados com data de nascimento e nacionalidade.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível em seu portal da Web. |
|
nome
|
name | string |
Nome ou alias da pessoa ou organização em qualquer idioma. |
|
|
número do documento
|
documentnumber | string |
Número do passaporte da pessoa, número de identificação nacional ou número da carta de condução, etc. |
|
|
entidade
|
entity | string |
pessoa: Pessoa; pessoa jurídica: Empresa ou Organização |
|
|
country
|
country | string |
Devolver apenas entidades com país/nacionalidade correspondente ou sem informação sobre o país. |
|
|
DOB
|
dob | string |
Devolva apenas entidades com informações de aniversário correspondentes ou sem informações de aniversário. |
|
|
base de dados
|
database | string |
Especifique os bancos de dados de origem para executar a verificação AML, se deixados em branco, todos os bancos de dados de origem serão verificados. Separe cada código de banco de dados com vírgula, por exemplo: un_sc,us_ofac. Para obter uma lista completa dos bancos de dados de origem e do código correspondente, visite AML API Overview. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
LMA
|
items | array of object |
Array contendo lista de correspondências AML, retorna uma matriz vazia se nenhuma correspondência foi encontrada. Para obter detalhes específicos, consulte AML API Reference. |
|
entidade
|
items.entity | string |
pessoa física ou jurídica |
|
nome completo
|
items.fullname | array of string |
Nome(s) da(s) pessoa(s) coletiva(s) |
|
Nome próprio
|
items.firstname | array of string |
Nome(s) próprio(s) |
|
Apelido
|
items.lastname | array of string |
Apelido(s) da pessoa |
|
nome do meio
|
items.middlename | array of string |
Nome(s) do meio(s) da pessoa |
|
alias
|
items.alias | array of string |
Nome(s) alternativo(s) ou estrangeiro(s) da entidade |
|
DOB
|
items.dob | array of string |
O aniversário de Peron pode vir nos formatos AAAA, AAAA-MM ou AAAA-MM-DD. |
|
address
|
items.address | array of string |
Endereço ou país de residência da entidade |
|
nacionalidade
|
items.nationality | array of string |
País ou nacionalidade da entidade |
|
local de nascimento
|
items.birthplace | array of string |
Local de nascimento de Perón |
|
Género
|
items.gender | array of string |
Sexo de Perón: M ou F |
|
número do documento
|
items.documentnumber | array of object |
Uma lista de documentos associados à entidade. |
|
id
|
items.documentnumber.id | string |
Número do documento |
|
id_formatted
|
items.documentnumber.id_formatted | string |
Número alfanumérico do documento |
|
country
|
items.documentnumber.country | string |
Código do país ISO2 |
|
tipo
|
items.documentnumber.type | string |
P = Número de passaporte, I = Número de identificação, D = Número da carta de condução, O = Outro/Tipo de documento desconhecido |
|
programa
|
items.program | array of string |
Programa(s) sancionatório(s) |
|
Observação
|
items.note | array of string |
Nota adicional para a entidade |
|
time
|
items.time | string |
Carimbo de data/hora UTC TZ quando a entidade foi adicionada à lista de fontes ou atualizada pela última vez |
|
estado
|
items.status | string |
Cargo/título da entidade ou situação atual da sanção |
|
origem
|
items.source | array of string |
Uma lista de URL(s) de origem oficial |
|
base de dados
|
items.database | string |
Código do banco de dados AML do ID Analyzer |
|
esquema
|
items.schema | string |
Treinamento de pesquisa facial
Antes de realizar a pesquisa facial, você deve emitir um comando train para treinar os conjuntos de dados de documentos dentro do seu cofre. Você também pode treinar seus dados do cofre através do portal da web. A tarefa de treinamento é assíncrona, o tempo de treinamento depende do número de entradas e imagens do vault. Pode levar de vários segundos a uma hora.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível em seu Portal da Web. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
sucesso
|
success | integer |
Validando o retorno de chamada
Para se certificar de que os dados foram enviados a partir do nosso servidor.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível em seu portal da Web. |
|
referenciar
|
reference | True | string |
Código de referência recebido em POST BODY. |
|
hash
|
hash | True | string |
Hash recebido em POST BODY. |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
sucesso
|
success | boolean | |
|
referenciar
|
reference | string |
Código de referência para a sessão DocuPass |