Analisador de ID (versão prévia)
O Analisador de ID fornece vários produtos de verificação de identidade diferentes, você precisa adquirir conhecimento básico de cada produto para escolher a melhor solução para seu aplicativo.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – 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 | |
|---|---|
| Publicador | Evith Techology |
| Site | https://www.idanalyzer.com/ |
| Política de privacidade | https://www.idanalyzer.com/privacy-policy.html |
| Categorias | Operações de TI; Produtividade |
A plataforma analisador de ID fornece a empresas, organizações e indivíduos uma solução de verificação de identidade verdadeiramente global que funciona sem bordas, uma solução que pode ser adaptada às suas necessidades e demandas específicas e um sistema de segurança que está sendo constantemente atualizado e aprimorado.
Fornecendo acesso completo de verificação de identidade e informações em mais de 4000 diferentes formas de ID em mais de 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 Analisador de ID. Você pode se registrar para uma conta gratuita na Inscrição
- Depois de se registrar na conta, você receberá uma chave de API no portal da Web do Analisador de ID. Use essa chave de API para autenticar com o conector
Como obter credenciais
- Navegar até a inscrição
- Insira as informações necessárias.
- Verifique seu email quando solicitado a fazê-lo.
- Você verá sua nova chave de API no portal da Web do Analisador de ID com os detalhes da sua conta. Pressione o botão "Copiar" para salvá-lo na área de transferência para uso posterior.
perguntas frequentes
Estou preocupado com a privacidade do meu cliente, a API salva informações sobre meu cliente?
Tudo será armazenado somente no cofre do cliente e não será vazado arbitrariamente. Ele não terá nenhuma cópia em outro lugar.
Para que são os "créditos", como posso comprar créditos de API?
Crédito pré-pago restante para sua conta. Se você tiver um plano mensal, sua cota mensal será usada antes do crédito pré-pago.
Como fazer para verificar se um documento é real ou falso?
Ative a autenticação, o resultado conterá a pontuação de autenticação.
Criando uma conexão
O conector dá suporte aos seguintes tipos de autenticação:
| Default | 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.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Chave de API de API | secureString | A chave de API para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Adicionar imagem ao cofre |
Você pode carregar uma imagem e adicioná-la a uma entrada de cofre existente fazendo 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 de cofre fazendo solicitação HTTP POST. |
| Configuração da API Principal |
A API de verificação de ID de várias funções para verificar o documento físico remoto, sua autenticidade e face correspondem ao documento com a foto do usuário. |
|
Criando sessão de assinatura do Docu |
Você pode criar uma sessão de assinatura em que o usuário examinará e assinará um documento legal sem verificação de identidade. Se você quiser executar a verificação de identidade e fazer com que o usuário assine algum documento, crie uma sessão de verificação de identidade. |
|
Criando sessão do Docu |
Você pode criar uma sessão de verificação para cada usuário que exige a verificação de identidade. |
| Excluir entrada do cofre |
Você pode excluir entradas de cofre única ou múltipla fazendo solicitação HTTP POST. |
| Excluir imagem do cofre |
Você pode excluir uma imagem dentro de uma entrada de cofre fazendo uma solicitação HTTP POST. Observe que, depois que uma imagem é excluída, a 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 pesquisar entradas com valores específicos, envie uma solicitação HTTP POST para o ponto de extremidade a seguir. |
| Obter conteúdo de entrada do cofre |
Quando as entradas forem adicionadas ao cofre, a API Core e a API do DocuPass retornarão um identificador de entrada do cofre 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 facial |
A pesquisa facial permite que você pesquise todo o cofre usando uma imagem de uma pessoa. Para usar o recurso de pesquisa facial, você deve habilitar a indexação de pesquisa facial no portal da Web e treinar os conjuntos de dados do cofre periodicamente. |
| Pesquisando banco de dados AML |
A API de AML permite que você pesquise o banco de dados AML global do Analisador de ID em busca de sanções, PEPs e criminosos procurados usando um nome, um número de documento ou ambos. Você pode filtrar ainda mais os resultados com aniversário e nacionalidade. |
| Status de treinamento |
Verifique se o treinamento do cofre ainda está em andamento ou se foi concluído. |
| Treinamento de pesquisa facial |
Antes de executar a pesquisa facial, você deve emitir um comando de trem para treinar os conjuntos de dados do documento dentro do cofre. Você também pode treinar os dados do cofre por meio do portal da Web. A tarefa de treinamento é assíncrona, o tempo de treinamento depende do número de entradas e imagens do cofre. Pode levar de vários segundos a uma hora. |
| Validando o retorno de chamada |
Para garantir que os dados foram enviados de nosso servidor. |
Adicionar imagem ao cofre
Você pode carregar uma imagem e adicioná-la a uma entrada de cofre existente fazendo solicitação HTTP POST.
Parâmetros
| Nome | Chave | Obrigató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 ao qual adicionar imagem |
|
tipo
|
type | True | string |
Definir o tipo de imagem: 0=document e 1=person |
|
imagem
|
image | string |
Dados de imagem codificados em Base64. |
|
|
imageurl
|
imageurl | string |
URL de imagem remota. |
Retornos
| Nome | 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 de imagem |
|
url
|
image.url | string |
URL para a imagem |
|
createtime
|
image.createtime | string |
A imagem de 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 de cofre fazendo solicitação HTTP POST.
Parâmetros
| Nome | Chave | Obrigató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 |
Linha de endereço 1. |
|
|
endereço2
|
address2 | string |
Linha de endereço 2. |
|
|
bloco
|
block | string |
Defina esse parâmetro para impedir que o mesmo documento seja enviado à API Core ou ao DocuPass. 0: Sem bloco 1: bloquear o número do documento 2: Bloquear nome/sobrenome 3: bloquear o número do documento e o nome/sobrenome. |
|
|
customdata1
|
customdata1 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada. |
|
|
customdata2
|
customdata2 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada. |
|
|
customdata3
|
customdata3 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada. |
|
|
customdata4
|
customdata4 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada. |
|
|
customdata5
|
customdata5 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada. |
|
|
Dob
|
dob | string |
Data de nascimento (YYYY-MM-DD). |
|
|
nome_do_documento
|
documentName | string |
Nome do documento. |
|
|
documentNumber
|
documentNumber | string |
O identificador exclusivo do documento (Passport No./Driver License No. etc) |
|
|
documentType
|
documentType | string |
P: Passport D: Carteira de Habilitação I: Carteira de Identidade V: Visa R: Cartão de Residência O: Outro |
|
|
docupass_customid
|
docupass_customid | string |
customid passado ao criar a verificação do DocuPass. |
|
|
docupass_failedreason
|
docupass_failedreason | string |
Se a verificação do DocuPass falhou, o motivo pelo qual ela falhou. |
|
|
docupass_reference
|
docupass_reference | string |
Código de referência para a sessão DocuPass. |
|
|
docupass_success
|
docupass_success | string |
0 ou 1, se a verificação do DocuPass foi bem-sucedida ou falhou. |
|
|
email
|
string |
Endereço de email do usuário. |
||
|
data de expiração
|
expiry | string |
Data de expiração (YYYY-MM-DD) |
|
|
eyeColor
|
eyeColor | string |
Cor dos olhos. |
|
|
primeiro nome
|
firstName | string |
Nome/ Nome fornecido |
|
|
firstName_local
|
firstName_local | string |
Nome no idioma local. |
|
|
fullName
|
fullName | string |
Nome completo (atualizar outros campos de nome não atualizará fullName) |
|
|
fullName_local
|
fullName_local | string |
Nome no idioma local. |
|
|
hairColor
|
hairColor | string |
Cor do cabelo. |
|
|
height
|
height | string |
Altura da pessoa. |
|
|
issueAuthority
|
issueAuthority | string |
Emitir autoridade do documento. |
|
|
Emitido
|
issued | string |
Data do problema (YYYY-MM-DD) |
|
|
issuerOrg_iso2
|
issuerOrg_iso2 | string |
Documento emitido código do país no ISO2. Exemplo: EUA |
|
|
issuerOrg_region_abbr
|
issuerOrg_region_abbr | string |
Sub-região/abreviação de estado do emissor do documento. Exemplo: AC |
|
|
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 |
Sobrenome/Nome da família. |
|
|
lastName_local
|
lastName_local | string |
Sobrenome no idioma local. |
|
|
nome do meio
|
middleName | string |
Nome do meio. |
|
|
middleName_local
|
middleName_local | string |
Nome do meio no idioma local. |
|
|
móvel
|
mobile | string |
Número de telefone celular do usuário. |
|
|
nationality_iso2
|
nationality_iso2 | string |
Nacionalidade do titular do documento no ISO2. Exemplo: EUA |
|
|
optionalData
|
optionalData | string |
Dados extra não especificados incluídos no documento. |
|
|
optionalData2
|
optionalData2 | string |
Dados extra não especificados incluídos no documento. |
|
|
personalNumber
|
personalNumber | string |
Um número de identificador secundário no documento. |
|
|
placeOfBirth
|
placeOfBirth | string |
Local de nascimento. |
|
|
Cp
|
postcode | string |
Endereço postcode. |
|
|
Restrições
|
restrictions | string |
Restrições de condução. |
|
|
sexo
|
sex | string |
M: Masculino F: Feminino X: Não especificado |
|
|
trustlevel
|
trustlevel | string |
0: Indeterminado 1: Documento inválido 2: Suspeito 3: Válido Essa pontuação será calculada automaticamente se a autenticação estiver habilitada. |
|
|
nota de confiança
|
trustnote | string | ||
|
vehicleClass
|
vehicleClass | string |
Classe de veículos na carteira de motorista. |
|
|
peso
|
weight | string |
Peso da pessoa. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
sucesso
|
success | integer |
Configuração da API Principal
A API de verificação de ID de várias funções para verificar o documento físico remoto, sua autenticidade e face correspondem ao documento com a foto do usuário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível no 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 imagem remota do 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 lado duplo. |
|
|
url_back
|
url_back | string |
Imagem remota da parte de trás do documento para executar uma verificação de lado duplo. |
|
|
face_base64
|
face_base64 | string |
Imagem codificada em Base64 do rosto de uma pessoa para executar a verificação biométrica de fotos. |
|
|
faceurl
|
faceurl | string |
Imagem remota do rosto de uma pessoa para executar a verificação biométrica de fotos. |
|
|
video_base64
|
video_base64 | string |
Vídeo de selfie codificado em Base64 para executar a verificação biométrica de vídeo. |
|
|
videourl
|
videourl | string |
Vídeo de selfie hospedado remotamente para executar a verificação biométrica de vídeo. |
|
|
senha
|
passcode | string |
Número de 4 dígitos |
|
|
exatidão
|
accuracy | integer |
Configure a velocidade e a precisão do reconhecimento de documentos e dos resultados do ocr. A baixa precisão reduzirá o tempo de resposta para menos de 1 segundo, enquanto a alta precisão geralmente levará 2 a 3 segundos. |
|
|
autenticar
|
authenticate | boolean |
Valide o documento para verificar se o documento é 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 nulo 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. |
|
|
outputmode
|
outputmode | string |
Produza o documento cortado e o rosto como conteúdo codificado em URL ou base64. |
|
|
dualsidecheck
|
dualsidecheck | boolean |
Verifique se os nomes, o número do documento e o tipo de documento correspondem entre a parte frontal e a parte de trás do documento ao executar uma verificação de lado duplo. Se alguma informação incompatibilidade o erro 14 for gerado. |
|
|
verify_expiry
|
verify_expiry | boolean |
Verifique se o documento ainda é válido com base na data de expiração. |
|
|
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. (YYYY/MM/DD) |
|
|
verify_age
|
verify_age | string |
Verifique se o titular do documento está envelhecido entre o intervalo especificado. (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á gerado. Separe vários valores com vírgula. Por exemplo, "EUA, AC" aceitaria documentos dos Estados Unidos e do Canadá. |
|
|
região
|
region | string |
Verifique se o documento foi emitido pelo estado especificado, se não o código de erro 11 será gerado. 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. |
|
|
checkblocklist
|
checkblocklist | boolean |
Verifique os dados do documento em relação às entradas bloqueadas em seu cofre. Se o documento corresponder a um dos erros de entrada bloqueado, 15 serão gerados |
|
|
vault_save
|
vault_save | boolean |
Salve a imagem do documento e as informações analisadas no cofre protegido. Você pode listar, pesquisar e atualizar entradas de documentos em seu cofre por meio da API do Cofre ou portal da Web. |
|
|
vault_saveunrecognized
|
vault_saveunrecognized | boolean |
Salve a imagem do documento no cofre mesmo que o documento não possa ser reconhecido. |
|
|
vault_noduplicate
|
vault_noduplicate | boolean |
Impedir que imagens duplicadas sejam salvas. |
|
|
vault_automerge
|
vault_automerge | boolean |
Mesclar automaticamente imagens com o mesmo número de documento em uma única entrada dentro do cofre. |
|
|
vault_customdata1
|
vault_customdata1 | string |
Adicione até cinco cadeias de caracteres personalizadas que serão associadas à entrada do cofre, isso pode ser útil para filtrar e pesquisar entradas. |
|
|
vault_customdata2
|
vault_customdata2 | string |
Adicione até cinco cadeias de caracteres personalizadas que serão associadas à entrada do cofre, isso pode ser útil para filtrar e pesquisar entradas. |
|
|
vault_customdata3
|
vault_customdata3 | string |
Adicione até cinco cadeias de caracteres personalizadas que serão associadas à entrada do cofre, isso pode ser útil para filtrar e pesquisar entradas. |
|
|
vault_customdata4
|
vault_customdata4 | string |
Adicione até cinco cadeias de caracteres personalizadas que serão associadas à entrada do cofre, isso pode ser útil para filtrar e pesquisar entradas. |
|
|
vault_customdata5
|
vault_customdata5 | string |
Adicione até cinco cadeias de caracteres personalizadas que serão associadas à entrada do cofre, isso pode ser útil para filtrar e pesquisar entradas. |
|
|
aml_check
|
aml_check | boolean |
Verifique o nome do titular do documento e o número do documento no Banco de Dados AML do Analisador de ID. |
|
|
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 apenas combinando entidades com exatamente a mesma nacionalidade e aniversário. |
|
|
contract_generate
|
contract_generate | string |
Contrair iD de modelo para preenchimento automático com dados do usuário. |
|
|
contract_format
|
contract_format | string |
Formato do documento de saída. Opções: PDF, DOCX, HTML. |
|
|
contract_prefill_data
|
contract_prefill_data | object |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
documentNumber
|
result.documentNumber | string |
Identificador exclusivo associado ao documento (por exemplo, Passport No./Driver License No./Card Number etc) |
|
personalNumber
|
result.personalNumber | string |
Identificador pessoal exclusivo associado à pessoa dentro de um país (por exemplo, Número da ID Nacional) |
|
primeiro nome
|
result.firstName | string |
Nome/ Nome fornecido |
|
sobrenome
|
result.lastName | string |
Sobrenome/Nome da família |
|
nome do meio
|
result.middleName | string |
Nome(s) do meio |
|
fullName
|
result.fullName | string |
Se o nome e o sobrenome não puderem ser distinguidos, o nome completo será retornado em vez disso |
|
firstName_local
|
result.firstName_local | string |
Nome 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 |
Gender M=Male F=Female X=Unspecified |
|
height
|
result.height | string |
Altura da pessoa |
|
peso
|
result.weight | string |
Peso da pessoa |
|
hairColor
|
result.hairColor | string |
Cor do cabelo – código de cor de cabelo ANSI D-20 (3 letras) |
|
eyeColor
|
result.eyeColor | string |
Cor dos olhos – código de cor do olho ANSI D-20 (3 letras) |
|
idade
|
result.age | integer |
Idade do titular do documento |
|
Dob
|
result.dob | string |
Data de nascimento em YYYY/MM/DD |
|
dob_day
|
result.dob_day | integer |
Data de nascimento de 1 a 31 |
|
dob_month
|
result.dob_month | integer |
Data de nascimento de 1 a 12 meses |
|
dob_year
|
result.dob_year | integer |
Data de nascimento do ano em YYYY |
|
data de expiração
|
result.expiry | string |
Data de expiração do documento em YYYY/MM/DD |
|
expiry_day
|
result.expiry_day | integer |
Dia de expiração de 1 a 31 |
|
expiry_month
|
result.expiry_month | integer |
Mês de expiração de 1 a 12 |
|
expiry_year
|
result.expiry_year | integer |
Ano de expiração em YYYY |
|
daysToExpiry
|
result.daysToExpiry | integer |
Número de dias antes do documento expirar |
|
Emitido
|
result.issued | string |
Data do problema em YYYY/MM/DD |
|
issued_day
|
result.issued_day | integer |
Dia da edição 1 a 31 |
|
issued_month
|
result.issued_month | integer |
Mês do problema de 1 a 12 |
|
issued_year
|
result.issued_year | integer |
Ano de problema no YYYY |
|
daysFromIssue
|
result.daysFromIssue | integer |
Número de dias desde que o documento foi emitido |
|
endereço1
|
result.address1 | string |
Linha de endereço 1 |
|
endereço2
|
result.address2 | string |
Linha de endereço 2 |
|
Cp
|
result.postcode | string |
Código postal de endereço |
|
placeOfBirth
|
result.placeOfBirth | string |
Local de nascimento |
|
vehicleClass
|
result.vehicleClass | string |
Classe de veículo de carteira de motorista |
|
Restrições
|
result.restrictions | string |
Restrições de carteira de motorista |
|
endosso
|
result.endorsement | string |
Endosso da carteira de motorista |
|
optionalData
|
result.optionalData | string |
Dados não especificados extras incluídos no documento |
|
optionalData2
|
result.optionalData2 | string |
Dados não especificados extras incluídos no documento |
|
documentType
|
result.documentType | string |
Tipo de documento: P=Passport, D=Driver's License, I=Identity Card, V=Visa, R=Residence Card, O=Other |
|
documentSide
|
result.documentSide | string |
Lado do documento: FRONT, BACK 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/abreviação de estado do emissor do documento. (por exemplo, AC) |
|
issuerOrg_full
|
result.issuerOrg_full | string |
País emitido pelo documento. (por exemplo, Estados Unidos) |
|
issuerOrg_iso2
|
result.issuerOrg_iso2 | string |
Documento emitido código do país no ISO2. (por exemplo, EUA) |
|
issuerOrg_iso3
|
result.issuerOrg_iso3 | string |
Documento emitido código do país no 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 no ISO2. (por exemplo, EUA) |
|
nationality_iso3
|
result.nationality_iso3 | string |
Nacionalidade do titular do documento no ISO3. (por exemplo, EUA) |
|
internalId
|
result.internalId | string |
Usado para identificar a ID de documento exclusiva no sistema do Analisador de ID, o mesmo tipo de documento deve ter a mesma ID. |
|
documentNumber
|
confidence.documentNumber | float |
nível de confiança de documentNumber |
|
primeiro nome
|
confidence.firstName | float |
nível de confiança de firstName |
|
sobrenome
|
confidence.lastName | float |
nível de confiança de Sobrenome /Nome da família |
|
nome do meio
|
confidence.middleName | float |
nível de confiança de Nomes do Meio |
|
dob_month
|
confidence.dob_month | float |
nível de confiança de dob_month |
|
dob_day
|
confidence.dob_day | float |
nível de confiança de dob_day |
|
dob_year
|
confidence.dob_year | float |
nível de confiança de dob_year |
|
issued_month
|
confidence.issued_month | float |
nível de confiança de issued_month |
|
issued_day
|
confidence.issued_day | float |
nível de confiança de issued_day |
|
issued_year
|
confidence.issued_year | float |
nível de confiança de issued_year |
|
expiry_month
|
confidence.expiry_month | float |
nível de confiança de expiry_month |
|
expiry_day
|
confidence.expiry_day | float |
nível de confiança de expiry_day |
|
expiry_year
|
confidence.expiry_year | float |
nível de confiança de expiry_year |
|
sexo
|
confidence.sex | float |
nível de confiança do sexo |
|
height
|
confidence.height | float |
nível de confiança de altura |
|
peso
|
confidence.weight | float |
nível de confiança de peso |
|
endereço1
|
confidence.address1 | float |
nível de confiança de address1 |
|
endereço2
|
confidence.address2 | float |
nível de confiança de address2 |
|
Cp
|
confidence.postcode | float |
nível de confiança do código postal |
|
vehicleClass
|
confidence.vehicleClass | float |
nível de confiança de vehicleClass |
|
Restrições
|
confidence.restrictions | float |
nível de confiança de restrições |
|
endosso
|
confidence.endorsement | float |
nível de confiança de endosso |
|
eyeColor
|
confidence.eyeColor | float |
nível de confiança de eyeColor |
|
idade
|
confidence.age | float |
nível de confiança da idade |
|
Dob
|
confidence.dob | float |
nível de confiança do dob |
|
daysToExpiry
|
confidence.daysToExpiry | float |
nível de confiança de daysToExpiry |
|
data de expiração
|
confidence.expiry | float |
nível de confiança de expiração |
|
Emitido
|
confidence.issued | float |
nível de confiança de emitido |
|
daysFromIssue
|
confidence.daysFromIssue | float |
nível de confiança de daysFromIssue |
|
fullName
|
confidence.fullName | float |
nível de confiança de fullName |
|
isIdentical
|
face.isIdentical | boolean |
Verificação biométrica aprovada ou com falha |
|
confiança
|
face.confidence | string |
Valor entre 0 a 1 sobre o quão semelhantes são os dois rostos, 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 localizar dados de rosto dentro da imagem facial |
|
Passado
|
verification.passed | boolean |
Se o documento tiver passado em todas as verificações, retornará true. 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. |
|
notexpired
|
verification.result.notexpired | boolean |
Se o documento ainda não expirou. |
|
nome
|
verification.result.name | boolean |
Se o nome fornecido corresponde ao nome analisado da ID. |
|
Dob
|
verification.result.dob | boolean |
Se o aniversário fornecido correspondeu ao aniversário analisado da ID. |
|
documentNumber
|
verification.result.documentNumber | boolean |
Se o número do documento fornecido corresponde ao número do documento analisado da ID. |
|
Cp
|
verification.result.postcode | boolean |
Se o código postal fornecido corresponde ao código postal analisado da ID. |
|
address
|
verification.result.address | boolean |
Se o endereço fornecido corresponde ao endereço analisado da ID. |
|
checkdigit
|
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. |
|
pontuação
|
authentication.score | float |
A pontuação será um float entre 0 e 1. Documentos válidos terão uma pontuação mais próxima de 1, enquanto 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 a pontuação menor que 0,5 |
|
Passado
|
authentication.breakdown.data_visibility.passed | boolean | |
|
Passado
|
authentication.breakdown.image_quality.passed | boolean | |
|
Passado
|
authentication.breakdown.feature_referencing.passed | boolean | |
|
Passado
|
authentication.breakdown.exif_check.passed | boolean | |
|
codificar
|
authentication.breakdown.exif_check.code | integer | |
|
reason
|
authentication.breakdown.exif_check.reason | string | |
|
severidade
|
authentication.breakdown.exif_check.severity | string | |
|
Passado
|
authentication.breakdown.publicity_check.passed | boolean | |
|
codificar
|
authentication.breakdown.publicity_check.code | integer | |
|
reason
|
authentication.breakdown.publicity_check.reason | string | |
|
severidade
|
authentication.breakdown.publicity_check.severity | string | |
|
Passado
|
authentication.breakdown.text_analysis.passed | boolean | |
|
Passado
|
authentication.breakdown.biometric_analysis.passed | boolean | |
|
Passado
|
authentication.breakdown.security_feature_check.passed | boolean | |
|
codificar
|
authentication.breakdown.security_feature_check.code | integer | |
|
reason
|
authentication.breakdown.security_feature_check.reason | string | |
|
severidade
|
authentication.breakdown.security_feature_check.severity | string | |
|
Passado
|
authentication.breakdown.recapture_check.passed | boolean | |
|
codificar
|
authentication.breakdown.recapture_check.code | integer | |
|
reason
|
authentication.breakdown.recapture_check.reason | string | |
|
severidade
|
authentication.breakdown.recapture_check.severity | string | |
|
aviso
|
authentication.warning | array of string |
Matriz de cadeia de caracteres que contém mensagens de aviso sobre a validade do documento. |
|
aml
|
aml | array of object |
Matriz que contém a lista de correspondências AML, retorna uma matriz vazia se nenhuma correspondência foi encontrada. Para obter detalhes específicos, consulte a Referência da API AML. |
|
entidade
|
aml.entity | string |
pessoa ou pessoa jurídica |
|
fullname
|
aml.fullname | array of string |
Nome da pessoa ou da entidade jurídica |
|
primeiro nome
|
aml.firstname | array of string |
Nome(s) da pessoa |
|
sobrenome
|
aml.lastname | array of string |
Sobrenome da pessoa |
|
middlename
|
aml.middlename | array of string |
Nome do meio da pessoa |
|
alias
|
aml.alias | array of string |
Nome(s) alternativo ou estrangeiro da entidade |
|
Dob
|
aml.dob | array of string |
O aniversário de Peron pode vir em formatos YYYY, YYYY-MM ou YYYY-MM-DD. |
|
address
|
aml.address | array of string |
Endereço ou país residente da entidade |
|
nacionalidade
|
aml.nationality | array of string |
País ou nacionalidade da entidade |
|
terra natal
|
aml.birthplace | array of string |
O local de nascimento de Peron |
|
gender
|
aml.gender | array of string |
Gênero de Peron: M ou F |
|
número de documentos
|
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 do documento alfanumérico |
|
country
|
aml.documentnumber.country | string |
Código do país ISO2 |
|
tipo
|
aml.documentnumber.type | string |
P = Número do passaporte, I = número de ID, D = Número da licença de condução, O = Outro tipo de documento/desconhecido |
|
programa
|
aml.program | array of string |
Programas de sanção |
|
nota
|
aml.note | array of string |
Observação adicional para a entidade |
|
time
|
aml.time | string |
Carimbo de data/hora utc TZ quando a entidade foi adicionada à lista de origem ou última atualização |
|
status
|
aml.status | string |
Posição/título da entidade ou status atual da sanção |
|
fonte
|
aml.source | array of string |
Uma lista de URLs de origem oficiais |
|
banco de dados
|
aml.database | string |
Código do banco de dados AML do Analisador de ID |
|
esquema
|
aml.schema | string | |
|
document_url
|
contract.document_url | string |
URL para documento gerado |
|
erro
|
contract.error | string |
Caso o contrato não seja gerado, esse campo conterá motivos como "ID de modelo de contrato inválida". |
|
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 taxa baixa indica que a imagem do documento está muito desfocada. |
|
saída
|
output | string |
Se a imagem de saída for definida como true e o outputmode for url, esse campo incluirá uma URL (ou uma matriz de URLs para verificação dualside) apontando para a imagem do documento cortada. O link só tem garantia de vida útil por 600 segundos e será removido a qualquer momento depois. |
|
outputface
|
outputface | string |
Se a face de saída for definida como true e o modelo de saída for url, esse campo incluirá uma URL apontando para a imagem facial cortada. O link só tem garantia de vida útil por 600 segundos e será removido a qualquer momento depois. |
|
Cortada
|
cropped | string |
Se a imagem de saída for definida como true e outputmode for base64, esse campo incluirá uma imagem codificada em base64 (ou uma matriz de imagens codificadas em base64 para verificação dualside) do documento cortado no formato JPEG |
|
croppedface
|
croppedface | string |
Se o outputface for definido como true e outputmode for base64, esse campo incluirá uma imagem codificada em base64 da região facial cortada do documento no formato JPEG |
|
tempo de execução
|
executionTime | float |
Tempo necessário para a operação de API em segundos. |
|
responseID
|
responseID | string |
Um identificador exclusivo para identificar a solicitação/resposta. |
|
cota
|
quota | integer |
Cota de API restante, redefinições no início de cada mês para assinante gratuito ou anual ou no início de cada ciclo de cobrança para assinante mensal. Se você tiver um plano de assinatura, sua cota mensal será usada antes do crédito. |
|
crédito
|
credit | integer |
Crédito de teste restante para sua conta. Se você tiver um plano de assinatura, sua cota mensal será usada antes do crédito. |
Criando sessão de assinatura do DocuPass
Você pode criar uma sessão de assinatura em que o usuário examinará e assinará um documento legal sem verificação de identidade. Se você quiser executar a verificação de identidade e fazer com que o usuário assine algum documento, crie uma sessão de verificação de identidade.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível no 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 |
Contrair iD de modelo 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 arquivo do contrato será enviado para essa URL. Você deve habilitar vault_save ou especificar um retorno de chamada para que possa salvar o documento gerado. |
|
|
successredir
|
successredir | string |
O navegador será redirecionado para essa URL depois que o documento for revisado e assinado. Código de referência do DocuPass e customid serão acrescentados ao final da URL |
|
|
customid
|
customid | string |
Uma cadeia de caracteres personalizada que será enviada de volta para a URL de retorno de chamada do servidor e acrescentada a URLs de redirecionamento definidas por successredir e failredir como uma cadeia de caracteres de consulta. É útil para identificar seu usuário em seu banco de dados. Esse valor será armazenado em docupass_customid no Cofre. |
|
|
reutilizável
|
reusable | boolean |
O nabling desse parâmetro permitirá que vários usuários examinem e assinem documentos por meio da mesma URL, um novo código de referência do DocuPass será gerado automaticamente para cada usuário. |
|
|
sms_contract_link
|
sms_contract_link | string |
Número de celular internacional completo |
|
|
vault_save
|
vault_save | boolean |
Salve o documento gerado no cofre. Você deve habilitar vault_save ou especificar um retorno de chamada para que possa salvar o documento gerado. |
|
|
nobranding
|
nobranding | boolean |
Ocultar o logotipo da identidade visual 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 no CSS, você precisará carregá-las em seu próprio servidor, no início de cada sessão, o DocuPass baixará a página HTML mais recente do servidor. |
|
|
linguagem
|
language | string |
O DocuPass detecta automaticamente o idioma do dispositivo do usuário e exibe o idioma correspondente. Defina esse parâmetro para substituir a detecção automática de idioma. (en, fr, nl, de, es, zh-TW, zh-CN) |
|
|
data de expiração
|
expiry | integer |
Número de segundos antes da expiração da sessão do DocuPass. Após a expiração, 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 |
|
|
qr_bgcolor
|
qr_bgcolor | string |
Cor da tela de fundo do código QR |
|
|
qr_size
|
qr_size | integer |
Tamanho do código QR |
|
|
qr_margin
|
qr_margin | integer |
Espessura da borda do código QR |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
referência
|
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 do DocuPass. |
|
url
|
url | string |
URL exclusiva para o aplicativo Web DocuPass. Envie este link para o usuário ou insira-o em seu site ou aplicativo móvel para examinar e assinar documento. |
|
qrcode
|
qrcode | string |
URL de imagem de código QR para o usuário verificar |
|
base_url
|
base_url | string |
Você pode enviar esse link para o usuário e solicitar que ele insira o código de referência para assinar documentos. |
|
html_qrcode
|
html_qrcode | string |
Html de exemplo para exibir o 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 êxito por meio de sms_contract_link parâmetro. |
|
data de expiração
|
expiry | integer |
O carimbo de data/hora UTC UNIX indicando quando esta sessão expirará, após a expiração, o usuário não poderá mais usar o link e um retorno de chamada com falha será enviado. |
Criando sessão do DocuPass
Você pode criar uma sessão de verificação para cada usuário que exige a verificação de identidade.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível no portal da Web. |
|
tipo
|
type | integer |
0: Módulo Iframe ,1: Módulo Móvel, 2: Módulo de Redirecionamento, 3: Módulo Móvel Dinâmico |
|
|
nome da empresa
|
companyname | True | string |
Sua empresa ou nome do produto. |
|
callbackurl
|
callbackurl | string |
URL de webhook/retorno de chamada para receber o resultado da verificação. |
|
|
biométrico
|
biometric | integer |
Peça ao usuário para tirar uma foto de selfie ou vídeo de 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 passar a validação. Defina 0 para desabilitar 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 essa URL quando a verificação de identidade for bem-sucedida. |
|
|
failredir
|
failredir | string |
O navegador será redirecionado para essa URL quando a verificação de identidade falhar. |
|
|
customid
|
customid | string |
É útil para identificar seu usuário em seu banco de dados. Esse valor será armazenado em docupass_customid no Cofre. |
|
|
reutilizável
|
reusable | boolean |
Habilitar esse parâmetro permitirá que vários usuários verifiquem sua identidade por meio da mesma URL, um novo código de referência do DocuPass será gerado automaticamente para cada usuário. |
|
|
phoneverification
|
phoneverification | boolean |
Se o usuário deve solicitar que o usuário insira um número de telefone para verificação, o DocuPass dá suporte à verificação de número de telefone móvel ou de telefone fixo. (Somente Assinante) |
|
|
documenttype
|
documenttype | string |
O usuário deve carregar um tipo específico de documento. Por exemplo, "PD" aceitaria passaporte e carteira de motorista. |
|
|
documentcountry
|
documentcountry | string |
Código de país ISO ALPHA-2. |
|
|
documentregion
|
documentregion | string |
Nome completo ou abreviação de estado/região. |
|
|
dualsidecheck
|
dualsidecheck | boolean |
Verifique se os nomes, o número do documento e o tipo de documento correspondem entre a parte frontal e a parte de trás do documento ao executar uma verificação de lado duplo. Se alguma informação incompatibilidade o erro 14 for gerado. |
|
|
verify_expiry
|
verify_expiry | boolean |
Aceitar apenas o documento que não expirou |
|
|
verify_documentno
|
verify_documentno | string |
Número do documento que exige verificação. |
|
|
verify_name
|
verify_name | string |
Nome completo, incluindo nome e sobrenome que exigem verificação. |
|
|
verify_dob
|
verify_dob | string |
Data de nascimento que exige verificação, no formato YYYY/MM/DD. |
|
|
verify_age
|
verify_age | string |
Faixa etária, exemplo: 18-40 |
|
|
verify_address
|
verify_address | string |
Endereço completo que exige verificação. |
|
|
verify_postcode
|
verify_postcode | string |
Código postal completo que exige verificação. |
|
|
verify_phone
|
verify_phone | string |
Número de telefone completo que exige verificação. |
|
|
vault_save
|
vault_save | boolean |
Salve documentos do usuário e analise as informações no cofre. |
|
|
return_documentimage
|
return_documentimage | boolean |
Retornar imagem de documento carregada pelo usuário na solicitação de retorno de chamada. |
|
|
return_faceimage
|
return_faceimage | boolean |
Retornar imagem facial 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, o conteúdo da imagem codificada em base64 ou uma URL para a imagem. (A URL para a imagem será mantida por apenas 7 dias) |
|
|
welcomemessage
|
welcomemessage | string |
Substitua a mensagem de saudação genérica na primeira página pelo texto personalizado (máximo de 1.000 caracteres) |
|
|
nobranding
|
nobranding | boolean |
Ocultar o logotipo da identidade visual em todas as páginas do DocuPass. (Somente Assinante) |
|
|
logotipo
|
logo | string |
Logotipo de identidade visual personalizado. (Somente Assinante) |
|
|
customhtmlurl
|
customhtmlurl | string |
Use sua própria página HTML e CSS para DocuPass. (Somente Assinante) |
|
|
linguagem
|
language | string |
O DocuPass detecta automaticamente o idioma do dispositivo do usuário e exibe o idioma correspondente. |
|
|
data de expiração
|
expiry | integer |
Número de segundos antes da expiração da sessão do DocuPass. Após a expiração, 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. (Somente para Live Mobile e Standard Mobile) |
|
|
qr_bgcolor
|
qr_bgcolor | string |
Cor da tela de fundo do código QR. (Somente para Live Mobile e Standard Mobile) |
|
|
qr_size
|
qr_size | integer |
Tamanho do código QR (1-50). (Somente para Live Mobile e Standard Mobile) |
|
|
qr_margin
|
qr_margin | integer |
Espessura da borda do QR Code (1-50). (Somente para Live Mobile e Standard Mobile) |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
referência
|
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 do DocuPass. |
|
url
|
url | string |
URL exclusiva para o aplicativo Web DocuPass. Envie este link para o usuário ou insira-o em seu site ou aplicativo móvel para iniciar a verificação de identidade. |
|
qrcode
|
qrcode | string |
URL de imagem de código QR para o usuário verificar |
|
base_url
|
base_url | string |
Você pode enviar esse link para o usuário e solicitar que ele insira o código de referência para iniciar a verificação. |
|
HTML
|
html | string |
HTML de exemplo 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 êxito por meio de sms_verification_link parâmetro. |
|
data de expiração
|
expiry | integer |
O carimbo de data/hora UTC UNIX indicando quando esta sessão expirará, após a expiração, o usuário não poderá mais usar o link e um retorno de chamada com falha será enviado. |
Excluir entrada do cofre
Você pode excluir entradas de cofre única ou múltipla fazendo solicitação HTTP POST.
Parâmetros
| Nome | Chave | Obrigató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 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
sucesso
|
success | integer |
Excluir imagem do cofre
Você pode excluir uma imagem dentro de uma entrada de cofre fazendo uma solicitação HTTP POST. Observe que, depois que uma imagem é excluída, a URL para a imagem ainda pode estar acessível por um curto período de tempo devido ao cache.
Parâmetros
| Nome | Chave | Obrigató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 ser excluída. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
sucesso
|
success | integer |
Listar e filtrar entradas
Para listar todas as entradas armazenadas dentro do cofre ou pesquisar entradas com valores específicos, envie uma solicitação HTTP POST para o ponto de extremidade a seguir.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível em seu Portal da Web. |
|
orderby
|
orderby | string |
Nome do campo usado para ordenar o resultado. |
|
|
classificar
|
sort | string |
ASC para classificar resulta em ordem crescente, DESC para classificar em ordem decrescente. |
|
|
limit
|
limit | integer |
Número de entradas do cofre a serem retornadas. (1 a 100) |
|
|
deslocamento
|
offset | integer |
Lista de retorno começando em 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 |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
limit
|
limit | integer |
Limite atual |
|
deslocamento
|
offset | integer |
Deslocamento atual |
|
nextoffset
|
nextoffset | integer |
Valor de deslocamento para o próximo conjunto de dados. Se o conjunto atual de dados for o conjunto final de dados, esse 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 cofre
Quando as entradas forem adicionadas ao cofre, a API Core e a API do DocuPass retornarão um identificador de entrada do cofre 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
| Nome | Chave | Obrigató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. |
Retornos
| Nome | 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 de entrada em UTC |
|
updatetime
|
data.updatetime | string |
Carimbo de data/hora da última modificação em UTC |
|
trustlevel
|
data.trustlevel | string |
Essa pontuação será 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, se a verificação do DocuPass foi bem-sucedida ou falhou. |
|
docupass_failedreason
|
data.docupass_failedreason | string |
Se a verificação do DocuPass falhou, o motivo pelo qual ela falhou. |
|
docupass_customid
|
data.docupass_customid | string |
customid passado ao criar a verificação do DocuPass. |
|
documentNumber
|
data.documentNumber | string |
O identificador exclusivo do documento (Passport No./Driver License No. etc) |
|
documentNumber_formatted
|
data.documentNumber_formatted | string |
Cadeia de caracteres gerada automaticamente de documentNumber sem símbolos, esse campo é útil para filtrar resultados. |
|
personalNumber
|
data.personalNumber | string |
Um número de identificador secundário no documento |
|
primeiro nome
|
data.firstName | string |
Nome/ Nome fornecido |
|
nome do meio
|
data.middleName | string |
Nome(s) do meio |
|
sobrenome
|
data.lastName | string |
Sobrenome/Nome da família |
|
fullName
|
data.fullName | string |
Nome completo (atualizar outros campos de nome não atualizará fullName) |
|
firstName_local
|
data.firstName_local | string |
Nome 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 do problema |
|
data de expiração
|
data.expiry | string |
Data de vencimento |
|
sexo
|
data.sex | string |
M: Masculino, F: Feminino, X: Não especificado |
|
height
|
data.height | string |
Altura da pessoa |
|
peso
|
data.weight | string |
Peso da pessoa |
|
hairColor
|
data.hairColor | string |
Cor do cabelo |
|
eyeColor
|
data.eyeColor | string |
Cor dos olhos |
|
endereço1
|
data.address1 | string |
Linha de endereço 1 |
|
endereço2
|
data.address2 | string |
Linha de endereço 2 |
|
Cp
|
data.postcode | string |
Código postal de endereço |
|
placeOfBirth
|
data.placeOfBirth | string |
Local de nascimento |
|
documentType
|
data.documentType | string |
P: Passport, D: Carteira de Habilitação, I: Cartão de Identidade, V: Visa, R: Cartão de Residência, O: Outro |
|
nome_do_documento
|
data.documentName | string |
Nome do documento |
|
vehicleClass
|
data.vehicleClass | string |
Classe de veículos na carteira de motorista |
|
Restrições
|
data.restrictions | string |
Restrições de condução |
|
endosso
|
data.endorsement | string |
Endosso da carteira de motorista |
|
email
|
data.email | string |
Endereço de email do usuário |
|
móvel
|
data.mobile | string |
Número de telefone celular do usuário |
|
telefone fixo
|
data.landline | string |
Número de telefone fixo do usuário |
|
issueAuthority
|
data.issueAuthority | string |
Emitir autoridade 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/abreviação de estado do emissor do documento. Exemplo: AC |
|
issuerOrg_iso2
|
data.issuerOrg_iso2 | string |
Documento emitido código do país no ISO2. Exemplo: EUA |
|
nationality_iso2
|
data.nationality_iso2 | string |
Nacionalidade do titular do documento no ISO2. Exemplo: EUA |
|
optionalData
|
data.optionalData | string |
Dados não especificados extras incluídos no documento |
|
optionalData2
|
data.optionalData2 | string |
Dados não especificados extras incluídos no documento |
|
customdata1
|
data.customdata1 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada |
|
customdata2
|
data.customdata2 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada |
|
customdata3
|
data.customdata3 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada |
|
customdata4
|
data.customdata4 | string |
5 cadeias de caracteres personalizadas que podem ser usadas para adicionar memorando personalizado à entrada |
|
customdata5
|
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 Core ou ao DocuPass. |
|
contrato
|
data.contract | string |
Link para contrato ou documentos legais gerados/assinados usando a API Core 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 de imagem |
|
url
|
data.image.url | string |
URL para a imagem |
|
createtime
|
data.image.createtime | string |
A imagem de hora foi carregada em UTC |
Pesquisa facial
A pesquisa facial permite que você pesquise todo o cofre usando uma imagem de uma pessoa. Para usar o recurso de pesquisa facial, você deve habilitar a indexação de pesquisa facial no portal da Web e treinar os conjuntos de dados do cofre periodicamente.
Parâmetros
| Nome | Chave | Obrigató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. |
|
|
maxentry
|
maxentry | integer |
Número de entradas correspondentes a serem retornadas, entre 1 e 10. |
|
|
limite
|
threshold | float |
Defina a pontuação mínima de similaridade facial necessária, no intervalo de 0 a 1. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
items
|
items | array of |
Se as entradas correspondentes forem encontradas, uma lista de documentos com conteúdo completo será retornada semelhante ao comando de lista. |
Pesquisando banco de dados AML
A API de AML permite que você pesquise o banco de dados AML global do Analisador de ID em busca de sanções, PEPs e criminosos procurados usando um nome, um número de documento ou ambos. Você pode filtrar ainda mais os resultados com aniversário e nacionalidade.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível no portal da Web. |
|
nome
|
name | string |
Nome ou alias de pessoa ou organização em qualquer idioma. |
|
|
número de documentos
|
documentnumber | string |
Número do passaporte da pessoa, número da ID nacional ou número da carteira de motorista etc. |
|
|
entidade
|
entity | string |
pessoa: Pessoa; pessoa jurídica: empresa ou organização |
|
|
country
|
country | string |
Retornar somente entidades com país/nacionalidade correspondentes ou sem informações de país. |
|
|
Dob
|
dob | string |
Retornar somente entidades com data de aniversário correspondente ou sem informações de aniversário. |
|
|
banco de dados
|
database | string |
Especifique os bancos de dados de origem para executar a verificação de AML, se deixado 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 de bancos de dados de origem e código correspondente, visite a Visão geral da API AML. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
aml
|
items | array of object |
Matriz que contém a lista de correspondências AML, retorna uma matriz vazia se nenhuma correspondência foi encontrada. Para obter detalhes específicos, consulte a Referência da API AML. |
|
entidade
|
items.entity | string |
pessoa ou pessoa jurídica |
|
fullname
|
items.fullname | array of string |
Nome da pessoa ou da entidade jurídica |
|
primeiro nome
|
items.firstname | array of string |
Nome(s) da pessoa |
|
sobrenome
|
items.lastname | array of string |
Sobrenome da pessoa |
|
middlename
|
items.middlename | array of string |
Nome do meio da pessoa |
|
alias
|
items.alias | array of string |
Nome(s) alternativo ou estrangeiro da entidade |
|
Dob
|
items.dob | array of string |
O aniversário de Peron pode vir em formatos YYYY, YYYY-MM ou YYYY-MM-DD. |
|
address
|
items.address | array of string |
Endereço ou país residente da entidade |
|
nacionalidade
|
items.nationality | array of string |
País ou nacionalidade da entidade |
|
terra natal
|
items.birthplace | array of string |
O local de nascimento de Peron |
|
gender
|
items.gender | array of string |
Gênero de Peron: M ou F |
|
número de documentos
|
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 do documento alfanumérico |
|
country
|
items.documentnumber.country | string |
Código do país ISO2 |
|
tipo
|
items.documentnumber.type | string |
P = Número do passaporte, I = número de ID, D = Número da licença de condução, O = Outro tipo de documento/desconhecido |
|
programa
|
items.program | array of string |
Programas de sanção |
|
nota
|
items.note | array of string |
Observação adicional para a entidade |
|
time
|
items.time | string |
Carimbo de data/hora utc TZ quando a entidade foi adicionada à lista de origem ou última atualização |
|
status
|
items.status | string |
Posição/título da entidade ou status atual da sanção |
|
fonte
|
items.source | array of string |
Uma lista de URLs de origem oficiais |
|
banco de dados
|
items.database | string |
Código do banco de dados AML do Analisador de ID |
|
esquema
|
items.schema | string |
Status de treinamento
Verifique se o treinamento do cofre ainda está em andamento ou se foi concluído.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível em seu Portal da Web. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
status
|
status | string |
não treinado: Nunca treinado, não iniciado: o treinamento não está em execução, em execução: o treinamento está em execução no momento, bem-sucedido: Treinamento bem-sucedido, falha: Falha no treinamento |
|
startTime
|
startTime | string |
Hora em que o último treinamento foi iniciado em UTC. |
|
statusChangeTime
|
statusChangeTime | string |
Hora da última alteração de status em UTC. |
|
lastSuccessTime
|
lastSuccessTime | string |
Hora do último treinamento bem-sucedido em UTC. |
|
erro
|
error | string |
Mensagem de erro associada ao status de treinamento com falha. |
Treinamento de pesquisa facial
Antes de executar a pesquisa facial, você deve emitir um comando de trem para treinar os conjuntos de dados do documento dentro do cofre. Você também pode treinar os dados do cofre por meio do portal da Web. A tarefa de treinamento é assíncrona, o tempo de treinamento depende do número de entradas e imagens do cofre. Pode levar de vários segundos a uma hora.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível em seu Portal da Web. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
sucesso
|
success | integer |
Validando o retorno de chamada
Para garantir que os dados foram enviados de nosso servidor.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Sua chave de API privada está disponível no portal da Web. |
|
referência
|
reference | True | string |
Código de referência recebido em POST BODY. |
|
hash
|
hash | True | string |
Hash recebido em POST BODY. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
sucesso
|
success | boolean | |
|
referência
|
reference | string |
Código de referência para a sessão DocuPass |