Register Face

Servicio que registra un rostro en una colección facial y devuelve el identificador asignado.

Endpoint

POST /biometric/face/collections/{collectionId}/faces

Headers

Nombre	Tipo	Requerido	Descripción
Authorization	string	Sí	Token de consumer en formato Bearer <token>. Ver Autenticación.
consumer-id	string	Sí	Identificador del consumer.
operation-id	string	Condicional	Identificador de la operación a la que pertenecen los assets referenciados. Requerido cuando source es FILE_KEY. Ver Storage.

Parámetros de ruta

Parámetro	Tipo	Requerido	Descripción
collectionId	string	Sí	Identificador de la colección.

Cuerpo de la solicitud

Content-Type: application/json

Parámetros

Parámetro	Tipo	Requerido	Descripción
source	string	Sí	Modo en que se aportan los assets: FILE_KEY para claves de assets almacenados, FILE para contenido en Base64. Ver Storage.
face	string	Sí	Rostro a registrar: clave del asset TOKEN_BEST_IMAGE o su contenido en Base64.

Ejemplo de solicitud

{
  "source": "FILE_KEY",
  "face": "0192a3f4-7b21-7c44-9e1a-3f5b8c2d1e04/TOKEN_BEST_IMAGE"
}

Respuestas

200 Éxito

Parámetros de respuesta

Parámetro	Tipo	Descripción
consumerId	string	Identificador del consumer que realizó la llamada.
transactionId	string	Identificador de la transacción.
timestamp	string	Marca de tiempo de la respuesta en formato ISO 8601.
message	string	Campo descriptivo del resultado de la ejecución del servicio.
collectionId	string	Colección en la que se registró el rostro.
faceId	string	Identificador del rostro registrado.

Otras respuestas

Código	Descripción
400	Campo obligatorio ausente o valor no admitido; falta la cabecera operation-id habiendo referencias; o una clave no tiene la forma {operationId}/{CONTEXTO} o declara un contexto que el hueco no admite.
403	El consumer no está aprovisionado con el servicio REGISTER_FACE.
404	La operación declarada en operation-id no existe o pertenece a otro consumer.
409	Un asset referenciado contiene un contenido ya procesado en otra operación.
410	La operación declarada en operation-id ha caducado.
422	Una clave nombra una operación distinta de la declarada en operation-id, o el contexto no tiene ningún asset almacenado.
429	El consumer ha superado su límite de tasa de peticiones, o un asset referenciado ha agotado su presupuesto de invocaciones en este endpoint. En el primer caso la respuesta incluye Retry-After, X-RateLimit-Limit y X-RateLimit-Burst, y esperar resuelve; en el segundo no. El servicio subyacente no se invoca y la llamada no se factura.

El cuerpo de una respuesta de error tiene la forma descrita en Middleware API v2.