Metadados

Visão geral

Metadados são quaisquer dados opcionais que você possa precisar adicionar a um objeto do sistema. Na meta_data seção, você pode incluir qualquer informação que quiser, simplesmente fornecendo qualquer número de campos com seus valores:

…
meta_data:
{
  "field1": "value1",
  "field2": "value2"
}
…

Objetos e métodos

Metadados estão disponíveis para a maioria dos objetos de sistema do Oz. Veja abaixo a lista desses objetos com os métodos da API necessários para adicionar metadados. Observe: também é possível adicionar metadados a esses objetos durante a criação deles.

Objeto	Método da API
Usuário	PATCH /api/users/{{user_id}}
Pasta	PATCH /api/folders/{{folder_id}}/meta_data/
Mídia	PATCH /api/media/{{media_id}}/meta_data
Análise	PATCH /api/analyses/{{analyse_id}}/meta_data
COLLECTION	PATCH /api/collections/{{collection_id}}/meta_data/ e, para uma pessoa em uma coleção, PATCH /api/collections/{{collection_id}}/persons/{{person_id}}/meta_data

Também é possível alterar ou excluir metadados. Consulte nossa documentação da API.

Exemplos de uso

Talvez seja útil usar metadados para agrupar pastas por uma pessoa ou lead. Por exemplo, se quiser calcular a conversão quando um único lead fizer várias tentativas de Liveness, basta adicionar o identificador da pessoa/lead aos metadados da pasta.

Veja como adicionar o ID do cliente iin a um objeto de pasta.

No corpo da requisição, adicione:

{
  "iin": "123123123"
}

É possível passar o ID de uma pessoa neste campo e usar esse ID para combinar requisições com a mesma pessoa e contar pessoas únicas (mesmo ID = mesma pessoa, IDs diferentes = pessoas diferentes). Esse ID pode ser um número de telefone, um IIN, um SSN ou qualquer outro tipo de ID exclusivo. O ID será exibido no relatório como uma coluna adicional.

Outro caso é a segurança: quando for necessário processar o resultado das análises no back-end, mas não se quiser fazer isso usando o ID da pasta. Adicione um ID (transaction_id) a esta pasta e use esse ID para buscar as informações necessárias. Este caso é explicado em detalhes aqui.

Se você armazenar PII em metadados, certifique-se de que isso esteja em conformidade com os requisitos regulatórios aplicáveis.

Também é possível adicionar metadados via SDK para processar as informações posteriormente usando métodos da API. Consulte as seções correspondentes do SDK:

• iOS

• Android

• Web