POST

/

compare

Compare two facial images

curl --request POST \
  --url https://idverify-api.argosidentity.com/modules/compare \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "originFace": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==",
  "targetFace": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==",
  "callbackUrl": "https://your-domain.com/callback"
}
'

{
  "apiType": "compare_face",
  "transactionId": "txn_123456789",
  "result": {
    "face": {
      "isAvailable": true,
      "boundingBox": {
        "Width": 0.42534321546554565,
        "Height": 0.567890123456789,
        "Left": 0.12345678901234566,
        "Top": 0.23456789012345677
      },
      "confidence": 0.9876543210987654
    },
    "targetFace": {
      "isAvailable": true,
      "boundingBox": {
        "Width": 0.4567890123456789,
        "Height": 0.543210987654321,
        "Left": 0.13456789012345677,
        "Top": 0.2456789012345679
      },
      "confidence": 0.9765432109876543
    },
    "similarity": {
      "score": 0.854321098765432,
      "threshold": 0.8,
      "isMatch": true
    }
  }
}

Face Compare API

La API de Face Compare permite a los usuarios comparar dos rostros para determinar su similitud. Con esta funcionalidad, los usuarios pueden medir fácilmente la semejanza entre dos imágenes faciales, permitiéndoles identificar y analizar similitudes o diferencias.

Descripción General de la API

La API de Face Compare proporciona una herramienta potente para el análisis de similitud facial con las siguientes capacidades:

Comparación de Dos Imágenes: Compare dos imágenes faciales lado a lado
Puntuación de Similitud: Obtenga puntuaciones de similitud precisas entre rostros
Alta Precisión: Algoritmos avanzados de IA para comparaciones confiables
Procesamiento Rápido: Análisis y tiempos de respuesta rápidos
Múltiples Formatos: Soporte para varios formatos de imagen
Enfoque en Privacidad: Sin almacenamiento de datos faciales, solo resultados de comparación

Parámetros de Solicitud

Parámetros Requeridos

originFace: Imagen codificada en Base64 del rostro a comparar con la imagen targetFace
targetFace: Imagen codificada en Base64 del rostro a comparar con la imagen originFace

Parámetros Opcionales

callbackUrl: La URL donde se enviarán los resultados de la comparación facial al completarse

Autenticación

x-api-key: Clave API esencial para fines de autenticación y control de acceso

Formato de Respuesta

La API devuelve resultados detallados de comparación que incluyen:

apiType: Identificador del tipo de API
transactionId: Identificador único para cada solicitud
result: Objeto que contiene el resultado del procesamiento
- face: Resultado del reconocimiento del originFace
- targetFace: Resultado del reconocimiento del targetFace
- similarity: Puntuación de similitud entre los dos rostros

Casos de Uso

Verificación de Identidad: Verifique si dos fotos pertenecen a la misma persona
Detección de Fraude: Detecte robo de identidad y documentos falsos
Control de Acceso: Verifique la identidad para sistemas de entrada seguros
Incorporación de Clientes: Garantice identidad consistente en los registros
Verificación de Documentos: Compare fotos de identificación con capturas en vivo

Modos de Procesamiento

Procesamiento Síncrono

Respuesta inmediata con resultados de comparación
Mejor para aplicaciones en tiempo real
Respuesta directa de la API

Procesamiento Asíncrono

Use URL de callback para resultados diferidos
Mejor para procesamiento por lotes
Formato detallado de respuesta de callback

Puntuación de Similitud

La API proporciona puntuaciones de similitud que indican qué tan estrechamente coinciden dos rostros:

Puntuación Alta (80-100%): Muy probablemente la misma persona
Puntuación Media (60-79%): Posiblemente la misma persona
Puntuación Baja (0-59%): Probablemente personas diferentes

Autorizaciones

x-api-key

string

header

requerido

Cuerpo

application/json

originFace

string

requerido

The base64 encoded image of the face to be compared with the targetFace image.

Base64 encoded characters in the payload must not include the MIME type. For example, if the encoded base64 characters are "image/png;base64,/9j/2wBDABQODxIP...", then remove "image/png;base64," and send only the encoded data "/9j/2wBDABQODxIP...".

Ejemplo:

"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="

targetFace

string

requerido

The base64 encoded image of the face to be compared with the originFace image.

Ejemplo:

"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="

callbackUrl

string<uri>

The URL where the face compare results will be sent upon completion. If a callbackUrl is provided, the process works asynchronously. If no callbackUrl is provided, the process operates synchronously.

Ejemplo:

"https://your-domain.com/callback"

Respuesta

Successful face comparison

apiType

string

API type identifier

Ejemplo:

"compare_face"

transactionId

string

Unique identifier for each request

Ejemplo:

"txn_123456789"

result

object

Object containing the processing result

Show child attributes

Ejemplos de Respuesta de Callback

⌘I

Compare two facial images

curl --request POST \
  --url https://idverify-api.argosidentity.com/modules/compare \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "originFace": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==",
  "targetFace": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==",
  "callbackUrl": "https://your-domain.com/callback"
}
'

{
  "apiType": "compare_face",
  "transactionId": "txn_123456789",
  "result": {
    "face": {
      "isAvailable": true,
      "boundingBox": {
        "Width": 0.42534321546554565,
        "Height": 0.567890123456789,
        "Left": 0.12345678901234566,
        "Top": 0.23456789012345677
      },
      "confidence": 0.9876543210987654
    },
    "targetFace": {
      "isAvailable": true,
      "boundingBox": {
        "Width": 0.4567890123456789,
        "Height": 0.543210987654321,
        "Left": 0.13456789012345677,
        "Top": 0.2456789012345679
      },
      "confidence": 0.9765432109876543
    },
    "similarity": {
      "score": 0.854321098765432,
      "threshold": 0.8,
      "isMatch": true
    }
  }
}