For the complete documentation index, see llms.txt. This page is also available as Markdown.

Obter coleções

Serviço que retorna as coleções faciais do consumer.

Endpoint

GET /biometric/face/collections

Cabeçalhos

Nome
Tipo
Obrigatório
Descrição

Authorization

string

Sim

Token de consumer no formato Bearer <token>. Ver Autenticação.

consumer-id

string

Sim

Identificador do consumer.

Respostas

200 Sucesso

Parâmetros de resposta

Parâmetro
Tipo
Descrição

consumerId

string

Identificador do consumer que realizou a chamada.

transactionId

string

Identificador da transação.

timestamp

string

Carimbo de data e hora da resposta no formato ISO 8601.

message

string

Campo descritivo do resultado da execução do serviço.

collectionIds

array

Identificadores das coleções do consumer.

Exemplo de resposta

{
  "consumerId": "consumer-web",
  "transactionId": "a29cbe15-2b68-495f-b7eb-be985b21c486",
  "timestamp": "2026-06-26T12:00:00.000Z",
  "message": "Service executed ok",
  "collectionIds": ["clientes-web", "lista-negra"]
}

Outras respostas

Código
Descrição

401

Token ausente, inválido ou expirado.

403

O consumer não está provisionado com o serviço FACE_COLLECTION_ADMIN.

O corpo de uma resposta de erro tem o formato descrito em MIDAPI v2.

Atualizado