Compartir a través de

Analizador de identificadores (versión preliminar)

El Analizador de identificadores proporciona varios productos de comprobación de identidades diferentes, debe adquirir conocimientos básicos de cada producto para elegir la mejor solución para la aplicación.

Este conector está disponible en los siguientes productos y regiones:

Service Class Regions
Copilot Studio Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas Estándar Todas las regiones de Logic Apps excepto las siguientes:
     - Regiones de Azure Government
     - Regiones de Azure China
     - Departamento de Defensa de EE. UU. (DoD)
Power Apps Premium Todas las regiones de Power Apps excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Power Automate Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Contacto
Nombre Compatibilidad con el analizador de identificadores
URL https://www.idanalyzer.com/contact.html
Correo Electrónico support@idanalyzer.com
Metadatos del conector
Publicador Techología evith
Sitio web https://www.idanalyzer.com/
Directiva de privacidad https://www.idanalyzer.com/privacy-policy.html
Categorías Operaciones de TI; Productividad

La plataforma del Analizador de identificadores proporciona a empresas, organizaciones e individuos una solución de verificación de identidad verdaderamente global que funciona sin fronteras, una solución que se puede adaptar a sus necesidades y demandas específicas, y un sistema de seguridad que se está actualizando y mejorando constantemente.

Proporcionar acceso completo a la verificación de identidad e información en más de 4000 formas de identificación diferentes en más de 190 países de todo el mundo, esta es una solución muy global diseñada con el mundo moderno en mente.

Prerrequisitos

  • Una cuenta de desarrollador con el Analizador de identificadores. Puede registrarse para obtener una cuenta gratuita en Registrarse.
  • Después de registrarse para la cuenta, se le proporcionará una clave de API en el portal web del analizador de identificadores. Uso de esta clave de API para autenticarse con el conector

Obtención de credenciales

  1. Vaya a Registrarse.
  2. Escriba en la información necesaria.
  3. Compruebe el correo electrónico cuando se le pida que lo haga.
  4. Verá la nueva clave de API en el portal web del analizador de identificadores con los detalles de la cuenta. Presione el botón "Copiar" para guardarlo en el Portapapeles para usarlo más adelante.

Preguntas más frecuentes

Me preocupa la privacidad de mi cliente, ¿la API guarda información sobre mi cliente?

Todo se almacenará solo en el almacén del cliente y no se perderá arbitrariamente. No tendrá ninguna copia en otro lugar.

¿Cuáles son los "créditos" para, ¿cómo puedo comprar créditos de API?

Crédito prepago restante para su cuenta. Si tiene un plan mensual, la cuota mensual se usará antes del crédito prepago.

¿Cómo puedo comprobar si un documento es real o falso?

Activar la autenticación, el resultado contendrá la puntuación de autenticación.

Creación de una conexión

El conector admite los siguientes tipos de autenticación:
Predeterminado Parámetros para crear una conexión. Todas las regiones No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre Tipo Description Obligatorio
Clave de API securestring La clave de API de esta API Cierto

Limitaciones

Nombre Llamadas Período de renovación
Llamadas API por conexión 100 60 segundos

Acciones

Agregar imagen al almacén

Puede cargar una imagen y agregarla a una entrada del almacén existente realizando una solicitud HTTP POST.
Búsqueda de caras

La búsqueda de caras permite buscar en todo el almacén mediante una imagen de una persona. Para usar la característica de búsqueda facial, debe habilitar la indexación de búsqueda facial en el portal web y entrenar periódicamente los conjuntos de datos del almacén.
Búsqueda de una base de datos AML

La API de AML permite buscar en la base de datos de AML global del Analizador de identificadores para sanciones, PEP y criminales deseados mediante un nombre, un número de documento o ambos. Puede filtrar aún más los resultados con cumpleaños y nacionalidad.
Configuración de la API principal

API de verificación de identificador de varias funciones para comprobar el documento físico remoto, su autenticidad y cara coinciden con el documento con la foto del usuario.
Creación de una sesión de DocuPass

Puede crear una sesión de comprobación para cada usuario que requiera la comprobación de identidad.
Creación de una sesión de firma de DocuPass

Puede crear una sesión de firma en la que el usuario revisará y firmará el documento legal sin comprobación de identidad. Si desea realizar la verificación de identidad y hacer que el usuario firme algún documento, cree una sesión de comprobación de identidad en su lugar.
Eliminación de la entrada del almacén

Puede eliminar entradas únicas o varias del almacén mediante la realización de una solicitud HTTP POST.
Eliminación de la imagen del almacén

Puede eliminar una imagen dentro de una entrada del almacén realizando una solicitud HTTP POST. Tenga en cuenta que después de eliminar una imagen, es posible que la dirección URL de la imagen siga siendo accesible durante un breve período de tiempo debido al almacenamiento en caché.
Entrada de Update Vault

Puede actualizar el valor de un único campo o valores de varios campos en una entrada del almacén realizando una solicitud HTTP POST.
Entrenamiento de Face Search

Antes de realizar la búsqueda facial, debe emitir un comando train para entrenar los conjuntos de datos del documento dentro del almacén. También puede entrenar los datos del almacén a través del portal web. La tarea de entrenamiento es asincrónica, el tiempo de entrenamiento depende del número de entradas e imágenes del almacén. Puede tardar de varios segundos a una hora.
Enumerar y filtrar entradas

Para enumerar todas las entradas almacenadas dentro del almacén o buscar entradas con valores específicos, envíe una solicitud HTTP POST al siguiente punto de conexión.
Estado de entrenamiento

Compruebe si el entrenamiento del almacén sigue en curso o se ha completado.
Obtener contenido de entrada del almacén

Cuando se agregan entradas al almacén, Core API y DocuPass API devolverán un identificador de entrada del almacén denominado vaultid. Puede usar el identificador para consultar el contenido de una entrada en el almacén mediante el envío de una solicitud HTTP POST al siguiente punto de conexión.
Validación de devolución de llamada

Para asegurarse de que los datos se enviaron desde nuestro servidor.

Agregar imagen al almacén

Id. de la operación:
AddImageToVault

Puede cargar una imagen y agregarla a una entrada del almacén existente realizando una solicitud HTTP POST.

Parámetros

Nombre Clave Requerido Tipo Description
apikey
 apikey True string

La clave de API privada está disponible en el portal web.
id
 id True string

Identificador de entrada del almacén al que se va a agregar la imagen
type
 type True string

Establezca el tipo de imagen: 0=document y 1=person
image
 image string

Datos de imagen codificados en Base64.
imageurl
 imageurl string

Dirección URL de la imagen remota.

Devoluciones

Nombre Ruta de acceso Tipo Description
correcto
 success integer
id
 image.id string

Identificador de imagen
type
 image.type string

0 para documento y 1 para persona
hash
 image.hash string

Hash MD5 de la imagen
URL
 image.url string

Dirección URL a la imagen
createtime
 image.createtime string

La imagen de hora se cargó en UTC

Búsqueda de caras

Id. de la operación:
FaceSearch

La búsqueda de caras permite buscar en todo el almacén mediante una imagen de una persona. Para usar la característica de búsqueda facial, debe habilitar la indexación de búsqueda facial en el portal web y entrenar periódicamente los conjuntos de datos del almacén.

Parámetros

Nombre Clave Requerido Tipo Description
apikey
 apikey True string

La clave de API privada está disponible en el portal web.
image
 image string

Datos de imagen codificados en Base64.
imageurl
 imageurl string

Dirección URL de la imagen remota.
maxentry
 maxentry integer

Número de entradas coincidentes que se van a devolver, entre 1 y 10.
threshold
 threshold float

Establezca la puntuación mínima de similitud de caras requerida, en el intervalo de 0 a 1.

Devoluciones

Nombre Ruta de acceso Tipo Description
items
 items array of

Si se encuentran entradas coincidentes, se devolverá una lista de documentos con contenido completo similar al comando list.

Búsqueda de una base de datos AML

Id. de la operación:
SearchingAML

La API de AML permite buscar en la base de datos de AML global del Analizador de identificadores para sanciones, PEP y criminales deseados mediante un nombre, un número de documento o ambos. Puede filtrar aún más los resultados con cumpleaños y nacionalidad.

Parámetros

Nombre Clave Requerido Tipo Description
apikey
 apikey True string

La clave de API privada está disponible en el portal web.
nombre
 name string

Nombre o alias de persona u organización en cualquier idioma.
documentnumber
 documentnumber string

Número de pasaporte de la persona, número de identificación nacional o número de licencia de conducir, etc.
entidad
 entity string

persona: persona; legalidad: Empresa u Organización
country
 country string

Devuelve solo entidades con país o nacionalidad coincidentes o sin información de país.
Dob
 dob string

Devuelve solo entidades con el cumpleaños coincidente o sin información de cumpleaños.
base de datos
 database string

Especifique las bases de datos de origen para realizar la comprobación de AML, si se deja en blanco, se comprobarán todas las bases de datos de origen. Separe cada código de base de datos con coma, por ejemplo: un_sc,us_ofac. Para obtener una lista completa de las bases de datos de origen y el código correspondiente, visite Introducción a la API de AML.

Devoluciones

Nombre Ruta de acceso Tipo Description
aml
 items array of object

Matriz que contiene la lista de coincidencias de AML, devuelve una matriz vacía si no se encontró ninguna coincidencia. Para obtener detalles específicos, consulte Referencia de api de AML.
entidad
 items.entity string

persona o legalentidad
fullname
 items.fullname array of string

Nombres de persona o entidad jurídica
nombre de pila
 items.firstname array of string

Nombre(s) de persona
apellido
 items.lastname array of string

Apellidos de persona
middlename
 items.middlename array of string

Nombres intermedios de persona
alias
 items.alias array of string

Nombres alternativos o externos de la entidad
Dob
 items.dob array of string

El cumpleaños de Peron podría venir en formatos AAAA, AAAA-MM o AAAA-MM-DD.
address
 items.address array of string

Dirección o país residente de la entidad
nacionalidad
 items.nationality array of string

País o nacionalidad de la entidad
lugar de nacimiento
 items.birthplace array of string

Lugar de nacimiento de Peron
gender
 items.gender array of string

Género de Peron: M o F
documentnumber
 items.documentnumber array of object

Lista de documentos asociados a la entidad.
id
 items.documentnumber.id string

Número de documento
id_formatted
 items.documentnumber.id_formatted string

Número de documento alfanumérico
country
 items.documentnumber.country string

Código de país ISO2
type
 items.documentnumber.type string

P = Número de pasaporte, I = número de identificación, D = Número de licencia de conducir, O = Otro tipo de documento desconocido
programa
 items.program array of string

Programas de sanción
nota
 items.note array of string

Nota adicional para la entidad
time
 items.time string

Marca de tiempo UTC TZ cuando se agregó la entidad a la lista de origen o a la última actualización
estado
 items.status string

Posición o título de la entidad o estado actual de la sanción
source
 items.source array of string

Lista de direcciones URL de origen oficiales
base de datos
 items.database string

Código de base de datos AML del analizador de identificadores
schema
 items.schema string

Configuración de la API principal

Id. de la operación:
SettingCoreAPI

API de verificación de identificador de varias funciones para comprobar el documento físico remoto, su autenticidad y cara coinciden con el documento con la foto del usuario.

Parámetros

Nombre Clave Requerido Tipo Description
apikey
 apikey True string

La clave de API privada está disponible en el portal web.
file_base64
 file_base64 string

Puede cargar una imagen codificada en base64 como una cadena mediante application/x-www-form-urlencoded o application/json.
URL
 url string

Core API es capaz de descargar imágenes remotas desde el servidor.
file_back_base64
 file_back_base64 string

Imagen codificada en Base64 de la parte posterior del documento para realizar un examen de doble lado.
url_back
 url_back string

Imagen remota de la parte posterior del documento para realizar un examen de dos lados.
face_base64
 face_base64 string

Imagen codificada en Base64 de la cara de una persona para realizar la verificación biométrica fotométrica.
faceurl
 faceurl string

Imagen remota de la cara de una persona para realizar la verificación biométrica fotométrica.
video_base64
 video_base64 string

Vídeo selfie codificado en Base64 para realizar la verificación biométrica de vídeo.
videourl
 videourl string

Vídeo selfie hospedado remoto para realizar la verificación biométrica de vídeo.
código de acceso
 passcode string

Número de 4 dígitos
exactitud
 accuracy integer

Configure la velocidad y precisión del reconocimiento de documentos y los resultados de ocr. La baja precisión reducirá el tiempo de respuesta a menos de 1 segundo, mientras que la alta precisión generalmente tardará 2~3 segundos.
authenticate
 authenticate boolean

Valide el documento para comprobar si el documento es auténtico y no se ha alterado.
authenticate_module
 authenticate_module string

Especifique el módulo usado para validar el documento.
biometric_threshold
 biometric_threshold float

Especificación de la puntuación mínima para pasar la verificación biométrica facial
return_confidence
 return_confidence boolean

Devuelve la puntuación de confianza de cada campo de datos.
return_empty
 return_empty boolean

Puede obtener que la API devuelva null en campos vacíos habilitando este parámetro.
ocr_scaledown
 ocr_scaledown integer

Número comprendido entre 500 y 4000 o 0
outputimage
 outputimage boolean

Genere una imagen recortada del documento.
outputface
 outputface boolean

Genere una imagen recortada de la región de la cara en el documento.
outputmode
 outputmode string

Genera el documento y la cara recortados como contenido codificado en base64 o url.
dualsidecheck
 dualsidecheck boolean

Compruebe si los nombres, el número de documento y el tipo de documento coinciden entre la parte delantera y la parte posterior del documento al realizar un examen de dos lados. Si se producirá algún error de coincidencia de información 14.
verify_expiry
 verify_expiry boolean

Compruebe si el documento sigue siendo válido en función de su fecha de expiración.
verify_documentno
 verify_documentno string

Compruebe si el número de documento proporcionado coincide con el documento.
verify_dob
 verify_dob string

Compruebe si la fecha de nacimiento proporcionada coincide con el documento. (AAAA/MM/DD)
verify_age
 verify_age string

Compruebe si el titular del documento está antiguo entre el intervalo especificado. (intervalo, ejemplo: 18-40)
verify_address
 verify_address string

Compruebe si la dirección proporcionada coincide con el documento.
verify_postcode
 verify_postcode string

Compruebe si el código postal proporcionado coincide con el documento.
country
 country string

Compruebe si el documento fue emitido por países especificados, si no se producirá el código de error 10. Separe varios valores con coma. Por ejemplo, "US,CA" aceptaría documentos de Estados Unidos y Canadá.
region
 region string

Compruebe si el documento se emitió mediante el estado especificado, si no se producirá el código de error 11. Separe varios valores con coma. Por ejemplo, "CA,TX" aceptaría documentos de California y Texas.
type
 type string

Compruebe si el documento era uno de los tipos especificados, si no se producirá el código de error 12. Por ejemplo, "PD" aceptaría el pasaporte y la licencia de conducir.
checkblocklist
 checkblocklist boolean

Compruebe los datos del documento con entradas bloqueadas en el almacén. Si el documento coincide con uno de los errores de entrada bloqueados 15 se producirá
vault_save
 vault_save boolean

Guarde la imagen del documento y la información analizada en el almacén protegido. Puede enumerar, buscar y actualizar entradas de documento en el almacén a través de la API de Vault o el portal web.
vault_saveunrecognized
 vault_saveunrecognized boolean

Guarde la imagen del documento en el almacén incluso si no se puede reconocer el documento.
vault_noduplicate
 vault_noduplicate boolean

Impedir que se guarden imágenes duplicadas.
vault_automerge
 vault_automerge boolean

Combine automáticamente imágenes con el mismo número de documento en una sola entrada dentro del almacén.
vault_customdata1
 vault_customdata1 string

Agregue hasta 5 cadenas personalizadas que se asociarán a la entrada del almacén, lo que puede resultar útil para filtrar y buscar entradas.
vault_customdata2
 vault_customdata2 string

Agregue hasta 5 cadenas personalizadas que se asociarán a la entrada del almacén, lo que puede resultar útil para filtrar y buscar entradas.
vault_customdata3
 vault_customdata3 string

Agregue hasta 5 cadenas personalizadas que se asociarán a la entrada del almacén, lo que puede resultar útil para filtrar y buscar entradas.
vault_customdata4
 vault_customdata4 string

Agregue hasta 5 cadenas personalizadas que se asociarán a la entrada del almacén, lo que puede resultar útil para filtrar y buscar entradas.
vault_customdata5
 vault_customdata5 string

Agregue hasta 5 cadenas personalizadas que se asociarán a la entrada del almacén, lo que puede resultar útil para filtrar y buscar entradas.
aml_check
 aml_check boolean

Compruebe el nombre del titular del documento y el número de documento en la base de datos AML del analizador de identificadores.
aml_database
 aml_database string

Separe cada código de base de datos con coma, por ejemplo: un_sc,us_ofac.
aml_strict_match
 aml_strict_match boolean

Habilite este parámetro para reducir los falsos positivos mediante la coincidencia de entidades exactamente con la misma nacionalidad y cumpleaños.
contract_generate
 contract_generate string

Identificador de plantilla de contrato para autorrellenar con datos de usuario.
contract_format
 contract_format string

Formato de documento de salida. Opcionales: PDF, DOCX, HTML.
contract_prefill_data
 contract_prefill_data object

Devoluciones

Nombre Ruta de acceso Tipo Description
documentNumber
 result.documentNumber string

Identificador único asociado al documento (por ejemplo, Passport No./Driver License No./Card Number, etc.)
personalNumber
 result.personalNumber string

Identificador personal único asociado a la persona dentro de un país (por ejemplo, número de identificación nacional)
firstName
 result.firstName string

Nombre/Nombre dado
lastName
 result.lastName string

Apellidos/Nombre de familia
Nombre del medio
 result.middleName string

Nombres intermedios
fullName
 result.fullName string

Si no se puede distinguir el nombre y el apellido, se devolverá el nombre completo en su lugar.
firstName_local
 result.firstName_local string

Nombre en idioma local si está disponible
lastName_local
 result.lastName_local string

Apellidos en idioma local si está disponible
middleName_local
 result.middleName_local string

Nombre intermedio en idioma local si está disponible
fullName_local
 result.fullName_local string

Nombre completo en idioma local si está disponible
sex
 result.sex string

Gender M=Male F=Female X=Unspecified
altura
 result.height string

Alto de la persona
weight
 result.weight string

Peso de la persona
hairColor
 result.hairColor string

Color del cabello : código de color ANSI D-20 (3 letras)
eyeColor
 result.eyeColor string

Color del ojo : código de color de ojo ANSI D-20 (3 letras)
edad
 result.age integer

Edad del titular del documento
Dob
 result.dob string

Fecha de nacimiento en AAAA/MM/DD
dob_day
 result.dob_day integer

Fecha de nacimiento del día 1 al 31
dob_month
 result.dob_month integer

Fecha de nacimiento del mes 1 al 12
dob_year
 result.dob_year integer

Fecha de nacimiento en AAAA
expiry
 result.expiry string

Fecha de expiración del documento en AAAA/MM/DD
expiry_day
 result.expiry_day integer

Día de expiración del 1 al 31
expiry_month
 result.expiry_month integer

Mes de expiración de 1 a 12
expiry_year
 result.expiry_year integer

Año de expiración en AAAA
daysToExpiry
 result.daysToExpiry integer

Número de días antes de que expire el documento
emitido
 result.issued string

Fecha de emisión en AAAA/MM/DD
issued_day
 result.issued_day integer

Día del problema del 1 al 31
issued_month
 result.issued_month integer

Mes del problema del 1 al 12
issued_year
 result.issued_year integer

Año de emisión en AAAA
daysFromIssue
 result.daysFromIssue integer

Número de días desde que se emitió el documento
Dirección1
 result.address1 string

Línea de dirección 1
dirección2
 result.address2 string

Línea de dirección 2
Cp
 result.postcode string

Código postal de dirección
placeOfBirth
 result.placeOfBirth string

Lugar de nacimiento
vehicleClass
 result.vehicleClass string

Clase de vehículo de licencia de conducir
Restricciones
 result.restrictions string

Restricciones de licencia de conducir
endoso
 result.endorsement string

Aprobación de licencia de conducir
optionalData
 result.optionalData string

Datos adicionales no específicos incluidos en el documento
optionalData2
 result.optionalData2 string

Datos adicionales no específicos incluidos en el 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 del documento: FRONT, BACK o BIODATA
issuerOrg_region_full
 result.issuerOrg_region_full string

Document issuer subdivision/state. (por ejemplo, California)
issuerOrg_region_abbr
 result.issuerOrg_region_abbr string

Abreviatura de estado/subred del emisor del documento. (por ejemplo, CA)
issuerOrg_full
 result.issuerOrg_full string

País emitido por el documento. (por ejemplo, Estados Unidos)
issuerOrg_iso2
 result.issuerOrg_iso2 string

Documento emitido código de país en ISO2. (por ejemplo, Estados Unidos)
issuerOrg_iso3
 result.issuerOrg_iso3 string

Documento emitido código de país en ISO3. (por ejemplo, EE. UU.)
nationality_full
 result.nationality_full string

Nacionalidad del titular del documento. (por ejemplo, Estados Unidos)
nationality_iso2
 result.nationality_iso2 string

Nacionalidad del titular del documento en ISO2. (por ejemplo, Estados Unidos)
nationality_iso3
 result.nationality_iso3 string

Nacionalidad del titular del documento en ISO3. (por ejemplo, EE. UU.)
internalId
 result.internalId string

Se usa para identificar el identificador de documento único en el sistema del Analizador de identificadores; el mismo tipo de documento debe tener el mismo identificador.
documentNumber
 confidence.documentNumber float

nivel de confianza de documentNumber
firstName
 confidence.firstName float

nivel de confianza de firstName
lastName
 confidence.lastName float

nivel de confianza de Apellidos /Nombre de familia
Nombre del medio
 confidence.middleName float

nivel de confianza de los nombres intermedios
dob_month
 confidence.dob_month float

nivel de confianza de dob_month
dob_day
 confidence.dob_day float

nivel de confianza de dob_day
dob_year
 confidence.dob_year float

nivel de confianza de dob_year
issued_month
 confidence.issued_month float

nivel de confianza de issued_month
issued_day
 confidence.issued_day float

nivel de confianza de issued_day
issued_year
 confidence.issued_year float

nivel de confianza de issued_year
expiry_month
 confidence.expiry_month float

nivel de confianza de expiry_month
expiry_day
 confidence.expiry_day float

nivel de confianza de expiry_day
expiry_year
 confidence.expiry_year float

nivel de confianza de expiry_year
sex
 confidence.sex float

nivel de confianza del sexo
altura
 confidence.height float

nivel de confianza de alto
weight
 confidence.weight float

nivel de confianza del peso
Dirección1
 confidence.address1 float

nivel de confianza de address1
dirección2
 confidence.address2 float

nivel de confianza de address2
Cp
 confidence.postcode float

nivel de confianza del código postal
vehicleClass
 confidence.vehicleClass float

nivel de confianza de vehicleClass
Restricciones
 confidence.restrictions float

nivel de confianza de restricciones
endoso
 confidence.endorsement float

nivel de confianza de aprobación
eyeColor
 confidence.eyeColor float

nivel de confianza de eyeColor
edad
 confidence.age float

nivel de confianza de edad
Dob
 confidence.dob float

nivel de confianza del dob
daysToExpiry
 confidence.daysToExpiry float

nivel de confianza de daysToExpiry
expiry
 confidence.expiry float

nivel de expiración de confianza
emitido
 confidence.issued float

nivel de confianza de emitido
daysFromIssue
 confidence.daysFromIssue float

nivel de confianza de daysFromIssue
fullName
 confidence.fullName float

nivel de confianza de fullName
isIdentical
 face.isIdentical boolean

Comprobación biométrica superada o con errores
confianza
 face.confidence string

Valor entre 0 y 1 sobre la similitud de las dos caras, 1 siendo idénticas.
error
 face.error integer

Código de error
error_message
 face.error_message string

Mensaje de error. Ejemplo: No se pudieron encontrar datos de caras dentro de la imagen facial
Pasado
 verification.passed boolean

Si el documento ha superado todas las comprobaciones, devolverá true. Si el documento ha producido un error al menos un tipo de comprobación, devolverá false.
cara
 verification.result.face boolean

Si la comprobación biométrica está habilitada, si la puntuación de confianza de similitud está por encima del umbral establecido.
notexpired
 verification.result.notexpired boolean

Si el documento aún no ha expirado.
nombre
 verification.result.name boolean

Indica si el nombre proporcionado coincide con el nombre analizado del identificador.
Dob
 verification.result.dob boolean

Indica si el cumpleaños proporcionado coincide con el cumpleaños analizado desde el identificador.
documentNumber
 verification.result.documentNumber boolean

Indica si el número de documento proporcionado coincide con el número de documento analizado del identificador.
Cp
 verification.result.postcode boolean

Indica si el código postal proporcionado coincide con el código postal analizado desde el identificador.
address
 verification.result.address boolean

Indica si la dirección proporcionada coincide con la dirección analizada desde el identificador.
checkdigit
 verification.result.checkdigit boolean

Si el tipo de documento tiene un algoritmo check digit/soundex, si los dígitos de comprobación son válidos.
edad
 verification.result.age boolean

Si el titular del documento está dentro del intervalo de antigüedad establecido.
cccode
 verification.result.cccode boolean

Si el tipo de documento tiene la implementación del código comercial chino (código CC), si los códigos CC son válidos.
puntuación
 authentication.score float

La puntuación será un float entre 0 y 1. Los documentos válidos tendrán una puntuación más cercana a 1, mientras que los documentos falsos o editados tendrán una puntuación más cercana a 0. Es su discreción decidir el límite, un buen punto inicial sería rechazar la puntuación inferior a 0,5
Pasado
 authentication.breakdown.data_visibility.passed boolean
Pasado
 authentication.breakdown.image_quality.passed boolean
Pasado
 authentication.breakdown.feature_referencing.passed boolean
Pasado
 authentication.breakdown.exif_check.passed boolean
código
 authentication.breakdown.exif_check.code integer
reason
 authentication.breakdown.exif_check.reason string
severity
 authentication.breakdown.exif_check.severity string
Pasado
 authentication.breakdown.publicity_check.passed boolean
código
 authentication.breakdown.publicity_check.code integer
reason
 authentication.breakdown.publicity_check.reason string
severity
 authentication.breakdown.publicity_check.severity string
Pasado
 authentication.breakdown.text_analysis.passed boolean
Pasado
 authentication.breakdown.biometric_analysis.passed boolean
Pasado
 authentication.breakdown.security_feature_check.passed boolean
código
 authentication.breakdown.security_feature_check.code integer
reason
 authentication.breakdown.security_feature_check.reason string
severity
 authentication.breakdown.security_feature_check.severity string
Pasado
 authentication.breakdown.recapture_check.passed boolean
código
 authentication.breakdown.recapture_check.code integer
reason
 authentication.breakdown.recapture_check.reason string
severity
 authentication.breakdown.recapture_check.severity string
warning
 authentication.warning array of string

Matriz de cadena que contiene mensajes de advertencia sobre la validez del documento.
aml
 aml array of object

Matriz que contiene la lista de coincidencias de AML, devuelve una matriz vacía si no se encontró ninguna coincidencia. Para obtener detalles específicos, consulte Referencia de api de AML.
entidad
 aml.entity string

persona o legalentidad
fullname
 aml.fullname array of string

Nombres de persona o entidad jurídica
nombre de pila
 aml.firstname array of string

Nombre(s) de persona
apellido
 aml.lastname array of string

Apellidos de persona
middlename
 aml.middlename array of string

Nombres intermedios de persona
alias
 aml.alias array of string

Nombres alternativos o externos de la entidad
Dob
 aml.dob array of string

El cumpleaños de Peron podría venir en formatos AAAA, AAAA-MM o AAAA-MM-DD.
address
 aml.address array of string

Dirección o país residente de la entidad
nacionalidad
 aml.nationality array of string

País o nacionalidad de la entidad
lugar de nacimiento
 aml.birthplace array of string

Lugar de nacimiento de Peron
gender
 aml.gender array of string

Género de Peron: M o F
documentnumber
 aml.documentnumber array of object

Lista de documentos asociados a la entidad.
id
 aml.documentnumber.id string

Número de documento
id_formatted
 aml.documentnumber.id_formatted string

Número de documento alfanumérico
country
 aml.documentnumber.country string

Código de país ISO2
type
 aml.documentnumber.type string

P = Número de pasaporte, I = número de identificación, D = Número de licencia de conducir, O = Otro tipo de documento desconocido
programa
 aml.program array of string

Programas de sanción
nota
 aml.note array of string

Nota adicional para la entidad
time
 aml.time string

Marca de tiempo UTC TZ cuando se agregó la entidad a la lista de origen o a la última actualización
estado
 aml.status string

Posición o título de la entidad o estado actual de la sanción
source
 aml.source array of string

Lista de direcciones URL de origen oficiales
base de datos
 aml.database string

Código de base de datos AML del analizador de identificadores
schema
 aml.schema string
document_url
 contract.document_url string

Dirección URL del documento generado
error
 contract.error string

En caso de que el contrato no se genere, este campo contendrá un motivo como "Id. de plantilla de contrato no válido".
vaultid
 vaultid string

Identificador único de la entrada del almacén si vault_save está habilitado.
matchrate
 matchrate float

La proporción de campos reconocidos correctamente por la API, una proporción baja indicaría que la imagen del documento es demasiado borrosa.
output
 output string

Si outputimage se establece en true y outputmode es url, este campo incluirá una dirección URL (o una matriz de direcciones URL para el examen de doble lado) que apunta a la imagen de documento recortada. El vínculo solo se garantiza que vive durante 600 segundos y se quitará en cualquier momento posterior.
outputface
 outputface string

Si outputface se establece en true y outputmode es url, este campo incluirá una dirección URL que apunta a la imagen de cara recortada. El vínculo solo se garantiza que vive durante 600 segundos y se quitará en cualquier momento posterior.
Recortada
 cropped string

Si outputimage se establece en true y outputmode es base64, este campo incluirá una imagen codificada en base64 (o una matriz de imágenes codificadas en base64 para el examen de doble lado) del documento recortado en formato JPEG.
croppedface
 croppedface string

Si outputface se establece en true y outputmode es base64, este campo incluirá una imagen codificada en base64 de la región facial recortada del documento en formato JPEG.
executionTime
 executionTime float

Tiempo necesario para la operación de API en segundos.
responseID
 responseID string

Identificador único para identificar la solicitud o respuesta.
quota
 quota integer

La cuota de API restante, se restablece al principio de cada mes para suscriptor gratuito o anual, o al inicio de cada ciclo de facturación para el suscriptor mensual. Si tiene un plan de suscripción, la cuota mensual se usará antes del crédito.
crédito
 credit integer

Crédito de prueba restante para su cuenta. Si tiene un plan de suscripción, la cuota mensual se usará antes del crédito.

Creación de una sesión de DocuPass

Id. de la operación:
CreatingDocuPass

Puede crear una sesión de comprobación para cada usuario que requiera la comprobación de identidad.

Parámetros

Nombre Clave Requerido Tipo Description
apikey
 apikey True string

La clave de API privada está disponible en el portal web.
type
 type integer

0: Módulo Iframe ,1: Módulo móvil, 2: Módulo de redirección, 3: Módulo móvil activo
companyname
 companyname True string

Su empresa o nombre de producto.
callbackurl
 callbackurl string

Dirección URL de webhook/devolución de llamada para recibir el resultado de la comprobación.
biométrico
 biometric integer

Pida al usuario que tome una foto selfie o un vídeo de selfie para la verificación de la cara.
biometric_threshold
 biometric_threshold float

Especificación de la puntuación mínima para pasar la verificación biométrica facial
authenticate_minscore
 authenticate_minscore float

El documento debe cumplir la puntuación de autenticidad mínima para pasar la validación. Establezca 0 para deshabilitar la comprobación de validez/autenticidad.
authenticate_module
 authenticate_module integer

Especifique el módulo usado para validar el documento.
maxattempt
 maxattempt integer

Número máximo de intentos de error para cada solicitud de comprobación.
successredir
 successredir string

El explorador se redirigirá a esta dirección URL cuando la comprobación de identidad se realice correctamente.
failredir
 failredir string

El explorador se redirigirá a esta dirección URL cuando se produzca un error en la comprobación de la identidad.
customid
 customid string

Resulta útil para identificar al usuario dentro de la base de datos. Este valor se almacenará en docupass_customid en Almacén.
reutilizable
 reusable boolean

Al habilitar este parámetro, varios usuarios podrán comprobar su identidad a través de la misma dirección URL, se generará automáticamente un nuevo código de referencia de DocuPass para cada usuario.
phoneverification
 phoneverification boolean

Si se le pide al usuario que escriba un número de teléfono para la verificación, DocuPass admite la verificación de números móviles o de línea fija. (Solo suscriptor)
documenttype
 documenttype string

El usuario debe cargar un tipo específico de documento. Por ejemplo, "PD" aceptaría el pasaporte y la licencia de conducir.
documentcountry
 documentcountry string

Código de país ISO ALPHA-2.
documentregion
 documentregion string

Nombre completo de estado o región o abreviatura.
dualsidecheck
 dualsidecheck boolean

Compruebe si los nombres, el número de documento y el tipo de documento coinciden entre la parte delantera y la parte posterior del documento al realizar un examen de dos lados. Si se producirá algún error de coincidencia de información 14.
verify_expiry
 verify_expiry boolean

Aceptar solo el documento que no ha expirado
verify_documentno
 verify_documentno string

Número de documento que requiere comprobación.
verify_name
 verify_name string

Nombre completo, incluido el nombre y apellidos que requieren la comprobación.
verify_dob
 verify_dob string

Fecha de nacimiento que requiere verificación, en formato AAAA/MM/DD.
verify_age
 verify_age string

Intervalo de edad, ejemplo: 18-40
verify_address
 verify_address string

Dirección completa que requiere comprobación.
verify_postcode
 verify_postcode string

Código postal completo que requiere comprobación.
verify_phone
 verify_phone string

Número de teléfono completo que requiere verificación.
vault_save
 vault_save boolean

Guarde los documentos de usuario y la información analizada en el almacén.
return_documentimage
 return_documentimage boolean

Devuelve la imagen del documento cargada por el usuario en la solicitud de devolución de llamada.
return_faceimage
 return_faceimage boolean

Devuelve la imagen de cara cargada por el usuario en la solicitud de devolución de llamada.
return_type
 return_type integer

Especifique el tipo de imagen que se va a devolver, ya sea contenido de imagen codificado en base64 o una dirección URL a la imagen. (La dirección URL a la imagen se conservará durante solo 7 días)
welcomemessage
 welcomemessage string

Reemplace el mensaje de saludo genérico en la primera página por el texto personalizado (máximo de 1000 caracteres)
nobranding
 nobranding boolean

Ocultar el logotipo de personalización de marca en todas las páginas docuPass. (Solo suscriptor)
logo
 logo string

Logotipo de personalización de marca personalizado. (Solo suscriptor)
customhtmlurl
 customhtmlurl string

Use su propia página HTML y CSS para DocuPass. (Solo suscriptor)
lenguaje
 language string

DocuPass detecta automáticamente el idioma del dispositivo de usuario y muestra el idioma correspondiente.
expiry
 expiry integer

Número de segundos antes de que expire la sesión de DocuPass. Tras la expiración, el usuario no podrá continuar con la sesión actual, también se enviará una devolución de llamada con error.
qr_color
 qr_color string

Color del primer plano del código QR. (Solo para Live Mobile y Standard Mobile)
qr_bgcolor
 qr_bgcolor string

Color del fondo del código QR. (Solo para Live Mobile y Standard Mobile)
qr_size
 qr_size integer

Tamaño del código QR(1-50). (Solo para Live Mobile y Standard Mobile)
qr_margin
 qr_margin integer

Grosor del borde del código QR(1-50). (Solo para Live Mobile y Standard Mobile)

Devoluciones

Nombre Ruta de acceso Tipo Description
referencia
 reference string

Un código de referencia único para la sesión de DocuPass.
type
 type integer

Tipo de módulo DocuPass creado.
customid
 customid string

Identificador personalizado que se usa al crear la sesión de DocuPass.
URL
 url string

Dirección URL única de la aplicación web DocuPass. Envíe este vínculo al usuario o insételo en su sitio web o aplicación móvil para comenzar la verificación de identidad.
qrcode
 qrcode string

Dirección URL de la imagen de código QR para que el usuario examine
base_url
 base_url string

Puede enviar este vínculo al usuario y pedirle que escriba el código de referencia para iniciar la comprobación.
html
 html string

HTML de ejemplo que puede insertar en la página web.
smssent
 smssent integer

Contiene el número de teléfono como confirmación cuando sms se ha enviado correctamente a través de sms_verification_link parámetro.
expiry
 expiry integer

Marca de tiempo DE UNIX UTC que indica cuándo expirará esta sesión, tras la expiración, el usuario ya no podrá usar el vínculo y se enviará una devolución de llamada con error.

Creación de una sesión de firma de DocuPass

Id. de la operación:
CreatingDocuPassSignatureSession

Puede crear una sesión de firma en la que el usuario revisará y firmará el documento legal sin comprobación de identidad. Si desea realizar la verificación de identidad y hacer que el usuario firme algún documento, cree una sesión de comprobación de identidad en su lugar.

Parámetros

Nombre Clave Requerido Tipo Description
apikey
 apikey True string

La clave de API privada está disponible en el portal web.
companyname
 companyname True string

El nombre de la empresa se mostrará a lo largo de la página de verificación para que el usuario final sepa que está enviando información de identidad a su empresa
template_id
 template_id string

Identificador de plantilla de contrato para autorrellenar con datos de usuario.
contract_format
 contract_format string

Formato de documento de salida. (PDF, DOCX, HTML)
callbackurl
 callbackurl string

El archivo de contrato se enviará a esta dirección URL. Debe habilitar vault_save o especificar una devolución de llamada para poder guardar el documento generado.
successredir
 successredir string

El explorador se redirigirá a esta dirección URL después de revisar y firmar el documento. El código de referencia de DocuPass y customid se anexarán al final de la dirección URL.
customid
 customid string

Cadena personalizada que se devolverá a la dirección URL de devolución de llamada del servidor y que se anexará a las direcciones URL de redireccionamiento establecidas por successredir y failredir como una cadena de consulta. Resulta útil para identificar al usuario dentro de la base de datos. Este valor se almacenará en docupass_customid en Almacén.
reutilizable
 reusable boolean

Al habilitar este parámetro, varios usuarios podrán revisar y firmar documentos a través de la misma dirección URL, se generará automáticamente un nuevo código de referencia de DocuPass para cada usuario.
sms_contract_link
 sms_contract_link string

Número de móvil internacional completo
vault_save
 vault_save boolean

Guarde el documento generado en el almacén. Debe habilitar vault_save o especificar una devolución de llamada para poder guardar el documento generado.
nobranding
 nobranding boolean

Ocultar el logotipo de personalización de marca en todas las páginas docuPass.
customhtmlurl
 customhtmlurl string

Use su propia página HTML y CSS para DocuPass. Una vez que haya realizado cambios en el CÓDIGO HTML y CSS, debe cargarlos en su propio servidor, al principio de cada sesión DocuPass descargará la página HTML más reciente del servidor.
lenguaje
 language string

DocuPass detecta automáticamente el idioma del dispositivo de usuario y muestra el idioma correspondiente. Establezca este parámetro para invalidar la detección automática de idioma. (en, fr, nl, de, es, zh-TW, zh-CN)
expiry
 expiry integer

Número de segundos antes de que expire la sesión de DocuPass. Tras la expiración, el usuario no podrá continuar con la sesión actual, también se enviará una devolución de llamada con error.
qr_color
 qr_color string

Color del primer plano del código QR
qr_bgcolor
 qr_bgcolor string

Color del fondo del código QR
qr_size
 qr_size integer

Tamaño del código QR
qr_margin
 qr_margin integer

Grosor del borde del código QR

Devoluciones

Nombre Ruta de acceso Tipo Description
referencia
 reference string

Un código de referencia único para la sesión de DocuPass.
customid
 customid string

Identificador personalizado que se usa al crear la sesión de DocuPass.
URL
 url string

Dirección URL única de la aplicación web DocuPass. Envíe este vínculo al usuario o inscríbalo en su sitio web o aplicación móvil para revisar y firmar el documento.
qrcode
 qrcode string

Dirección URL de la imagen de código QR para que el usuario examine
base_url
 base_url string

Puede enviar este vínculo al usuario y pedirle que escriba código de referencia para firmar documentos.
html_qrcode
 html_qrcode string

HTML de ejemplo para mostrar código QR en la página web.
html_iframe
 html_iframe string

HTML de ejemplo para insertar iframe en la página web.
smssent
 smssent string

Contiene el número de teléfono como confirmación cuando sms se ha enviado correctamente a través de sms_contract_link parámetro.
expiry
 expiry integer

Marca de tiempo DE UNIX UTC que indica cuándo expirará esta sesión, tras la expiración, el usuario ya no podrá usar el vínculo y se enviará una devolución de llamada con error.

Eliminación de la entrada del almacén

Id. de la operación:
DeleteVaultEntry

Puede eliminar entradas únicas o varias del almacén mediante la realización de una solicitud HTTP POST.

Parámetros

Nombre Clave Requerido Tipo Description
apikey
 apikey True string

La clave de API privada está disponible en el portal web.
id
 id True array of string

id

Devoluciones

Nombre Ruta de acceso Tipo Description
correcto
 success integer

Eliminación de la imagen del almacén

Id. de la operación:
DeleteImageFromVault

Puede eliminar una imagen dentro de una entrada del almacén realizando una solicitud HTTP POST. Tenga en cuenta que después de eliminar una imagen, es posible que la dirección URL de la imagen siga siendo accesible durante un breve período de tiempo debido al almacenamiento en caché.

Parámetros

Nombre Clave Requerido Tipo Description
apikey
 apikey True string

La clave de API privada está disponible en el portal web.
id
 id True string

Identificador de entrada del almacén que contiene la imagen.
imageid
 imageid string

id de la imagen que se va a eliminar.

Devoluciones

Nombre Ruta de acceso Tipo Description
correcto
 success integer

Entrada de Update Vault

Id. de la operación:
UpdateVaultEntry

Puede actualizar el valor de un único campo o valores de varios campos en una entrada del almacén realizando una solicitud HTTP POST.

Parámetros

Nombre Clave Requerido Tipo Description
apikey
 apikey True string

La clave de API privada está disponible en el portal web.
id
 id True string

Identificador de entrada del almacén.
Dirección1
 address1 string

Línea de dirección 1.
dirección2
 address2 string

Línea de dirección 2.
Bloquear
 block string

Establezca este parámetro para impedir que el mismo documento se envíe a Core API o DocuPass. 0: No bloque 1: Bloquear número de documento 2: Nombre del bloque/apellido 3: Bloquear número de documento y nombre/apellido.
customdata1
 customdata1 string

5 cadenas personalizadas que se pueden usar para agregar un memo personalizado a la entrada.
customdata2
 customdata2 string

5 cadenas personalizadas que se pueden usar para agregar un memo personalizado a la entrada.
customdata3
 customdata3 string

5 cadenas personalizadas que se pueden usar para agregar un memo personalizado a la entrada.
customdata4
 customdata4 string

5 cadenas personalizadas que se pueden usar para agregar un memo personalizado a la entrada.
customdata5
 customdata5 string

5 cadenas personalizadas que se pueden usar para agregar un memo personalizado a la entrada.
Dob
 dob string

Fecha de nacimiento (AAAA-MM-DD).
Nombre del documento
 documentName string

Nombre del documento.
documentNumber
 documentNumber string

Identificador único del documento (Passport No./Driver License No. etc.)
documentType
 documentType string

P: Passport D: Driver's License I: Identity Card V: Visa R: Residence Card O: Other
docupass_customid
 docupass_customid string

customid pasado al crear la comprobación de DocuPass.
docupass_failedreason
 docupass_failedreason string

Si se ha producido un error en la comprobación de DocuPass, el motivo por el que se produjo un error.
docupass_reference
 docupass_reference string

Código de referencia a la sesión de DocuPass.
docupass_success
 docupass_success string

0 o 1, tanto si la comprobación de DocuPass se realizó correctamente como si se produjo un error.
Correo electrónico
 email string

Dirección de correo electrónico del usuario.
expiry
 expiry string

Fecha de expiración (AAAA-MM-DD)
eyeColor
 eyeColor string

Color del ojo.
firstName
 firstName string

Nombre/Nombre dado
firstName_local
 firstName_local string

Nombre en idioma local.
fullName
 fullName string

Nombre completo (la actualización de otros campos de nombre no actualizará fullName)
fullName_local
 fullName_local string

Nombre en idioma local.
hairColor
 hairColor string

Color del cabello.
altura
 height string

Altura de la persona.
issueAuthority
 issueAuthority string

Emitir autoridad del documento.
emitido
 issued string

Fecha de emisión (AAAA-MM-DD)
issuerOrg_iso2
 issuerOrg_iso2 string

Documento emitido código de país en ISO2. Ejemplo: EE. UU.
issuerOrg_region_abbr
 issuerOrg_region_abbr string

Abreviatura de estado/subred del emisor del documento. Ejemplo: CA
issuerOrg_region_full
 issuerOrg_region_full string

Document issuer subdivision/state. Ejemplo: California
teléfono fijo
 landline string

Número de teléfono fijo del usuario.
lastName
 lastName string

Apellidos/Nombre de familia.
lastName_local
 lastName_local string

Apellidos en idioma local.
Nombre del medio
 middleName string

Nombres intermedios.
middleName_local
 middleName_local string

Nombre intermedio en idioma local.
mobile
 mobile string

Número de teléfono móvil del usuario.
nationality_iso2
 nationality_iso2 string

Nacionalidad del titular del documento en ISO2. Ejemplo: EE. UU.
optionalData
 optionalData string

Datos adicionales no específicos incluidos en el documento.
optionalData2
 optionalData2 string

Datos adicionales no específicos incluidos en el documento.
personalNumber
 personalNumber string

Número de identificador secundario en el documento.
placeOfBirth
 placeOfBirth string

Lugar de nacimiento.
Cp
 postcode string

Código postal de dirección.
Restricciones
 restrictions string

Restricciones de conducción.
sex
 sex string

M: Macho F: Hembra X: Sin especificar
trustlevel
 trustlevel string

0: Sin determinar 1: Documento no válido 2: Sospechoso 3: Esta puntuación se calcula automáticamente si la autenticación está habilitada.
trustnote
 trustnote string
vehicleClass
 vehicleClass string

Clase de vehículos en licencia de conducir.
weight
 weight string

Peso de la persona.

Devoluciones

Nombre Ruta de acceso Tipo Description
correcto
 success integer
Id. de la operación:
FaceSearchTraining

Antes de realizar la búsqueda facial, debe emitir un comando train para entrenar los conjuntos de datos del documento dentro del almacén. También puede entrenar los datos del almacén a través del portal web. La tarea de entrenamiento es asincrónica, el tiempo de entrenamiento depende del número de entradas e imágenes del almacén. Puede tardar de varios segundos a una hora.

Parámetros

Nombre Clave Requerido Tipo Description
apikey
 apikey True string

La clave de API privada está disponible en el portal web.

Devoluciones

Nombre Ruta de acceso Tipo Description
correcto
 success integer

Enumerar y filtrar entradas

Id. de la operación:
ListVaultEntries

Para enumerar todas las entradas almacenadas dentro del almacén o buscar entradas con valores específicos, envíe una solicitud HTTP POST al siguiente punto de conexión.

Parámetros

Nombre Clave Requerido Tipo Description
apikey
 apikey True string

La clave de API privada está disponible en el portal web.
orderby
 orderby string

Nombre del campo usado para ordenar el resultado.
sort
 sort string

ASC para ordenar los resultados en orden ascendente, DESC para ordenar en orden descendente.
limit
 limit integer

Número de entradas del almacén que se van a devolver. (de 1 a 100)
offset
 offset integer

Lista devuelta a partir de una entrada específica, por ejemplo, cuando limit=10, para acceder a la tercera página de los resultados, use offset=20
filtro
 filter array of string

filtro

Devoluciones

Nombre Ruta de acceso Tipo Description
limit
 limit integer

Límite actual
offset
 offset integer

Desplazamiento actual
nextoffset
 nextoffset integer

Valor de desplazamiento para el siguiente conjunto de datos. Si el conjunto actual de datos es el conjunto final de datos, este campo no se devolverá.
total
 total integer

Número total de entradas encontradas.
items
 items array of

Matriz de entradas encontradas y su contenido completo, idéntico al contenido devuelto por el método GET.

Estado de entrenamiento

Id. de la operación:
TrainingStatus

Compruebe si el entrenamiento del almacén sigue en curso o se ha completado.

Parámetros

Nombre Clave Requerido Tipo Description
apikey
 apikey True string

La clave de API privada está disponible en el portal web.

Devoluciones

Nombre Ruta de acceso Tipo Description
estado
 status string

nottrained: Never trained, notstarted: Training is not running, running: Training is currently running, succeeded: Training succeeded, failed: Training failed
startTime
 startTime string

Hora a la que se inició el último entrenamiento en UTC.
statusChangeTime
 statusChangeTime string

Hora del último cambio de estado en UTC.
lastSuccessTime
 lastSuccessTime string

Hora para el último entrenamiento correcto en UTC.
error
 error string

Mensaje de error asociado al estado de entrenamiento con errores.

Obtener contenido de entrada del almacén

Id. de la operación:
GetVault

Cuando se agregan entradas al almacén, Core API y DocuPass API devolverán un identificador de entrada del almacén denominado vaultid. Puede usar el identificador para consultar el contenido de una entrada en el almacén mediante el envío de una solicitud HTTP POST al siguiente punto de conexión.

Parámetros

Nombre Clave Requerido Tipo Description
apikey
 apikey True string

La clave de API privada está disponible en el portal web.
id
 id string

Identificador de entrada del almacén.

Devoluciones

Nombre Ruta de acceso Tipo Description
correcto
 success integer
id
 data.id string

Identificador de entrada del almacén
createtime
 data.createtime string

Marca de tiempo de creación de entrada en UTC
updatetime
 data.updatetime string

Marca de tiempo de la última modificación en UTC
trustlevel
 data.trustlevel string

Esta puntuación se calcula automáticamente si la autenticación está habilitada. (0: Sin determinar, 1: Documento no válido, 2: Sospechoso, 3: Válido)
trustnote
 data.trustnote string

Advertencias asociadas a la validez del documento.
docupass_reference
 data.docupass_reference string

Código de referencia a la sesión de DocuPass
docupass_success
 data.docupass_success string

0 o 1, tanto si la comprobación de DocuPass se realizó correctamente como si se produjo un error.
docupass_failedreason
 data.docupass_failedreason string

Si se ha producido un error en la comprobación de DocuPass, el motivo por el que se produjo un error.
docupass_customid
 data.docupass_customid string

customid pasado al crear la comprobación de DocuPass.
documentNumber
 data.documentNumber string

Identificador único del documento (Passport No./Driver License No. etc.)
documentNumber_formatted
 data.documentNumber_formatted string

Cadena generada automáticamente de documentNumber sin símbolos, este campo es útil para filtrar los resultados.
personalNumber
 data.personalNumber string

Un número de identificador secundario en el documento
firstName
 data.firstName string

Nombre/Nombre dado
Nombre del medio
 data.middleName string

Nombres intermedios
lastName
 data.lastName string

Apellidos/Nombre de familia
fullName
 data.fullName string

Nombre completo (la actualización de otros campos de nombre no actualizará fullName)
firstName_local
 data.firstName_local string

Nombre en idioma local
middleName_local
 data.middleName_local string

Nombre intermedio en idioma local
lastName_local
 data.lastName_local string

Apellidos en idioma local
fullName_local
 data.fullName_local string

Nombre completo en idioma local
Dob
 data.dob string

Fecha de nacimiento
emitido
 data.issued string

Fecha del problema
expiry
 data.expiry string

Fecha de vencimiento
sex
 data.sex string

M: Macho, F: Hembra, X: Sin especificar
altura
 data.height string

Alto de la persona
weight
 data.weight string

Peso de la persona
hairColor
 data.hairColor string

Color del cabello
eyeColor
 data.eyeColor string

Color del ojo
Dirección1
 data.address1 string

Línea de dirección 1
dirección2
 data.address2 string

Línea de dirección 2
Cp
 data.postcode string

Código postal de dirección
placeOfBirth
 data.placeOfBirth string

Lugar de nacimiento
documentType
 data.documentType string

P: Passport, D: Driver's License, I: Identity Card, V: Visa, R: Residence Card, O: Other
Nombre del documento
 data.documentName string

Nombre del documento
vehicleClass
 data.vehicleClass string

Clase de vehículos en licencia de conducir
Restricciones
 data.restrictions string

Restricciones de conducción
endoso
 data.endorsement string

Aprobación de licencia de conducir
Correo electrónico
 data.email string

Dirección de correo electrónico del usuario
mobile
 data.mobile string

Número de teléfono móvil del usuario
teléfono fijo
 data.landline string

Número de teléfono fijo de usuario
issueAuthority
 data.issueAuthority string

Autoridad de emisión del documento
issuerOrg_region_full
 data.issuerOrg_region_full string

Document issuer subdivision/state. Ejemplo: California
issuerOrg_region_abbr
 data.issuerOrg_region_abbr string

Abreviatura de estado/subred del emisor del documento. Ejemplo: CA
issuerOrg_iso2
 data.issuerOrg_iso2 string

Documento emitido código de país en ISO2. Ejemplo: EE. UU.
nationality_iso2
 data.nationality_iso2 string

Nacionalidad del titular del documento en ISO2. Ejemplo: EE. UU.
optionalData
 data.optionalData string

Datos adicionales no específicos incluidos en el documento
optionalData2
 data.optionalData2 string

Datos adicionales no específicos incluidos en el documento
customdata1
 data.customdata1 string

5 cadenas personalizadas que se pueden usar para agregar un memo personalizado a la entrada
customdata2
 data.customdata2 string

5 cadenas personalizadas que se pueden usar para agregar un memo personalizado a la entrada
customdata3
 data.customdata3 string

5 cadenas personalizadas que se pueden usar para agregar un memo personalizado a la entrada
customdata4
 data.customdata4 string

5 cadenas personalizadas que se pueden usar para agregar un memo personalizado a la entrada
customdata5
 data.customdata5 string

5 cadenas personalizadas que se pueden usar para agregar un memo personalizado a la entrada
Bloquear
 data.block string

Establezca este parámetro para impedir que el mismo documento se envíe a Core API o DocuPass.
contrato
 data.contract string

Vínculo a documentos legales o de contrato generados o firmados mediante Core API o DocuPass
image
 data.image array of object

Contiene una lista de imágenes asociadas a la entrada.
id
 data.image.id string

Identificador de imagen
type
 data.image.type string

0 para documento y 1 para persona
hash
 data.image.hash string

Hash MD5 de la imagen
URL
 data.image.url string

Dirección URL a la imagen
createtime
 data.image.createtime string

La imagen de hora se cargó en UTC

Validación de devolución de llamada

Id. de la operación:
ValidatingCallback

Para asegurarse de que los datos se enviaron desde nuestro servidor.

Parámetros

Nombre Clave Requerido Tipo Description
apikey
 apikey True string

La clave de API privada está disponible en el portal web.
referencia
 reference True string

Código de referencia recibido en POST BODY.
hash
 hash True string

Hash recibido en POST BODY.

Devoluciones

Nombre Ruta de acceso Tipo Description
correcto
 success boolean
referencia
 reference string

Código de referencia para la sesión de DocuPass