Utilice este método para comprobar si el procesador biométrico está listo para funcionar.
Llame GET /{version}/face/pattern/health
Ninguno.
GET localhost/v1/face/pattern/health
En caso de éxito, el método devuelve un mensaje con los siguientes parámetros.
Tipo de contenido de la respuesta HTTP: “application/json”.
El método está diseñado para extraer una plantilla biométrica de una imagen.
Tipo de contenido de la petición HTTP: “image / jpeg” or “image / png”
Llame POST /{version}/face/pattern/extract
En caso de éxito, el método devuelve una plantilla biométrica.
Tipo de contenido de la respuesta HTTP: “application/octet-stream”.
El método está diseñado para comparar dos plantillas biométricas.
Tipo de contenido de la petición HTTP: “multipart / form-data”.
Llame POST /{version}/face/pattern/compare
En caso de éxito, el método devuelve el resultado de la comparación de las dos plantillas.
Tipo de contenido de la respuesta HTTP: “application/json”.
El método combina los dos métodos anteriores, extract y compare. Extrae una plantilla de una imagen y compara la plantilla biométrica resultante con otra plantilla biométrica que también se pasa en la solicitud.
Tipo de contenido de la petición HTTP: “multipart / form-data”.
Llame POST /{version}/face/pattern/verify
En caso de éxito, el método devuelve el resultado de la comparación de dos plantillas biométricas y la plantilla biométrica.
Tipo de contenido de la respuesta HTTP: “multipart/form-data”.
El método también combina los dos métodos anteriores, extract y compare. Extrae plantillas de dos imágenes, compara las plantillas biométricas obtenidas y transmite el resultado de la comparación como respuesta.
Tipo de contenido de la petición HTTP: “multipart / form-data”.
Llame POST /{version}/face/pattern/extract_and_compare
En caso de éxito, el método devuelve el resultado de la comparación de las dos plantillas biométricas extraídas.
Tipo de contenido de la respuesta HTTP: “application / json”.
Utilice este método para comparar una plantilla biométrica con otras N.
Tipo de contenido de la petición HTTP: “multipart/form-data”.
Llame POST /{version}/face/pattern/compare_n
En caso de éxito, el método devuelve el resultado de la comparación 1:N.
Tipo de contenido de la respuesta HTTP: “application / json”.
El método combina los métodos extract y compare_n. Extrae una plantilla biométrica de una imagen y la compara con otras N plantillas biométricas que se pasan en la solicitud como una lista.
Tipo de contenido de la petición HTTP: “multipart/form-data”.
Llame POST /{version}/face/pattern/verify_n
En caso de éxito, el método devuelve el resultado de la comparación 1:N.
Tipo de contenido de la respuesta HTTP: “application / json”.
Este método también combina los métodos extract y compare_n, pero de otra manera. Extrae plantillas biométricas de la imagen principal y de una lista de otras imágenes y luego las compara en el modo 1:N.
Tipo de contenido de la petición HTTP: “multipart/form-data”.
Llame POST /{version}/face/pattern/
extract_and_compare_n
En caso de éxito, el método devuelve el resultado de la comparación 1:N.
Tipo de contenido de la respuesta HTTP: “application / json”.
Tipo de contenido de la respuesta HTTP: “application / json”.
*la muestra biométrica es una imagen de entrada
Utilice este método para comprobar si el procesador de liveness está listo para funcionar.
Llame GET /{version}/face/liveness/health
Ninguno.
GET localhost/v1/face/liveness/health
En caso de éxito, el método devuelve un mensaje con los siguientes parámetros.
Tipo de contenido de la respuesta HTTP: “application/json”.
El método está diseñado para detectar ataques de presentación en imágenes.
Tipo de contenido de la petición HTTP: “image/jpeg” or “image/png”
Llame POST /{version}/face/liveness/detect
En caso de éxito, el método devuelve una estimación de la presencia de un ataque de presentación en la imagen.
Tipo de contenido de la respuesta HTTP: “application/json”.
Tipo de contenido de la respuesta HTTP: “application / json”.
Nombre del parámetro
Valor
Descripción
status
Number
0: el procesador biométrico funciona correctamente.
3: el procesador biométrico no funciona.
message
String
Mensaje.
Nombre del parámetro
Valor
Descripción
-
Stream
Parámetro obligatorio. Imagen para extraer la plantilla biométrica.
El campo del encabezado "Content-Type" debe indicar el tipo de contenido.
Parameter name
Valor
Descripción
-
Stream
Una plantilla biométrica derivada de una imagen
Nombre del parámetro
Valor
Descripción
bio_feature
Stream
Parámetro obligatorio.
Primera plantilla biométrica.
bio_template
Stream
Parámetro obligatorio.
Segunda plantilla biométrica.
Nombre del parámetro
Valor
Descripción
score
Number
El resultado de comparar dos plantillas
decision
String
Solución recomendada en función de la puntuación.
approved: positivo. Los rostros coinciden.
operator_required: se requiere que el operador realice una verificación adicional.
declined: resultado negativo. Los rostros no coinciden.
Nombre del parámetro
Valor
Descripción
sample
Stream
Parámetro obligatorio.
Imagen para extraer la plantilla biométrica.
bio_template
Stream
Parámetro obligatorio.
La plantilla biométrica con la que se realizará la comparación.
Nombre del parámetro
Valor
Descripción
score
Number
El resultado de comparar dos plantillas
bio_feature
Stream
Plantilla biométrica derivada de la imagen
Nombre del parámetro
Valor
Descripción
sample_1
Stream
Parámetro obligatorio.
Primera imagen.
sample_2
Stream
Parámetro obligatorio.
SSegunda imagen.
Nombre del parámetro
Valor
Descripción
score
Number
El resultado de la comparación de las dos plantillas extraídas.
decision
String
Solución recomendada en función de la puntuación.
approved: positivo. Los rostros coinciden.
operator_required: se requiere que el operador realice una verificación adicional.
declined: resultado negativo. Los rostros no coinciden.
Nombre del parámetro
Valor
Descripción
template_1
Stream
Parámetro obligatorio. La primera plantilla biométrica (principal)
templates_n
Stream
Una lista de N plantillas biométricas. Cada uno de ellos debe pasarse por separado, pero el nombre del parámetro debe ser templates_n
. También es necesario pasar el nombre del archivo en el encabezado.
Nombre del parámetro
Valor
Descripción
results
List[JSON]
Una lista de N resultados de comparación. El resultado N contiene el resultado de la comparación de las plantillas principal y N. El resultado tiene los siguientes campos:
*filename
String
Un nombre de archivo para la plantilla N.
*score
Number
El resultado de la comparación de las plantillas principal y N.
*decision
String
Solución recomendada en función de la puntuación.
approved: positivo. Los rostros coinciden.
operator_required: se requiere que el operador realice una verificación adicional.
declined: resultado negativo. Los rostros no coinciden.
Nombre del parámetro
Valor
Descripción
sample_1
Stream
Parámetro obligatorio. La imagen principal.
templates_n
Stream
Una lista de N plantillas biométricas. Cada uno de ellos debe pasarse por separado, pero el nombre del parámetro debe ser templates_n
. También es necesario pasar el nombre del archivo en el encabezado.
Nombre del parámetro
Valor
Descripción
results
List[JSON]
AUna lista de N resultados de comparación. El enésimo resultado contiene el resultado de la comparación de la plantilla derivada de la imagen principal y la enésima plantilla. El resultado tiene los siguientes campos:
*filename
String
Un nombre de archivo para la plantilla N.
*score
Number
El resultado de comparar la plantilla derivada de la imagen principal y la plantilla N.
*decision
String
Solución recomendada en función de la puntuación.
approved: positivo. Los rostros coinciden.
operator_required: se requiere que el operador realice una verificación adicional.
declined: resultado negativo. Los rostros no coinciden.
Nombre del parámetro
Valor
Descripción
sample_1
Stream
Parámetro obligatorio. La primera imagen (principal).
samples_n
Stream
Una lista de N imágenes. Cada una de ellas debe pasarse por separado, pero el nombre del parámetro debe ser samples_n
. También es necesario pasar el nombre del archivo en el encabezado.
Nombre del parámetro
Valor
Descripción
results
List[JSON]
Una lista de N resultados de comparación. El resultado N contiene el resultado de la comparación de las imágenes principales y N. El resultado tiene los siguientes campos:
*filename
String
Un valor filename para la imagen N.
*score
Number
El resultado de la comparación entre la imagen principal y la N.
*decision
String
Solución recomendada en función de la puntuación.
approved: positivo. Los rostros coinciden.
operator_required: se requiere que el operador realice una verificación adicional.
declined: resultado negativo. Los rostros no coinciden.
Códigos de respuesta HTTP
El valor del parámetro "code"
Descripción
400
BPE-002001
Content-Type no válido de la solicitud HTTP
400
BPE-002002
Método de solicitud HTTP no válido
400
BPE-002003
No se pudo leer la muestra biométrica*
400
BPE-002005
IContent-Type no válido de la parte de la solicitud HTTP multipart
400
BPE-003001
No se pudo recuperar la plantilla biométrica
400
BPE-003002
La muestra biométrica* no contiene el rostro
400
BPE-003003
Más de una persona está presente en la muestra biométrica*.
500
BPE-001001
Error interno del bioprocesador
Nombre del parámetro
Valor
Descripción
status
Number
0: el procesador de liveness funciona correctamente.
3: el procesador de liveness está inoperante.
message
String
Mensaje.
Nombre del parámetro
Valor
Descripción
-
Stream
Parámetro obligatorio. Una imagen.
El campo del encabezado "Content-Type" debe indicar el tipo de contenido.
Nombre del parámetro
Valor
Descripción
score
Number
Evaluación de la presencia de un ataque de presentación en la imagen en una escala de 0 (sin signos de ataque) a 1 (máxima confianza de la presencia de un ataque).
passed
Boolean
Solución recomendada en función de la puntuación.
True
: no hay ningún ataque de presentación en la imagen.
False
: la imagen contiene un ataque de presentación.
Códigos de respuesta HTTP
El valor del parámetro "code"
Description
400
LDE-002001
Content-Type no válido de la solicitud HTTP
400
LDE-002002
Método de solicitud HTTP no válido
400
LDE-002003
No se pudo extraer la muestra biométrica
400
LDE-002005
Content-Type no válido de la parte de la solicitud HTTP multipart
500
LDE-001001
Error interno del procesador de detección de liveness
Qué es Oz API Lite, cuándo y cómo utilizarla.
Oz API Lite es la versión ligera pero potente de Oz API. La versión Lite exige menos recursos, es más productiva y más fácil de usar. Los análisis se realizan dentro de la imagen API Lite. Como Oz API Lite no incluye ningún servicio adicional como estadísticas o almacenamiento de datos, esta versión es la que debe utilizar cuando necesites un alto rendimiento.
Sólo un componente para clusterizar
No es necesario el almacenamiento de datos: mayor nivel de seguridad de la información
Arquitectura más sencilla: plazos de proyecto más cortos
Menos tráfico (una imagen en vez de un video)
Para comprobar el procesador Liveness, llame GET /{version}/face/liveness/health
.
Para comprobar el procesador Biometry, llame GET /{version}/face/pattern/health
.
Para realizar la prueba de Liveness de una imagen, llame POST /{version}/face/liveness/detect
(toma una imagen como entrada y muestra la evaluación de posibilidad de ataque de spoofing en esta imagen)
Para comparar dos rostros en dos imágenes, llame POST /{version}/face/pattern/extract_and_compare
(toma dos imágenes como entrada, deriva las plantillas de biometría de estas imágenes y las compara). Para comparar una imagen con un grupo de imágenes, llame POST /{version}/face/pattern/extract_and_compare_n
.
Para ver la lista completa de métodos de Oz API Lite, consulte Métodos de la API.