Pessoas do FaceMatch

Endpoints para consulta e exclusão de pessoas cadastradas no FaceMatch, destinados a integrações servidor a servidor.

Cadastro e atualização

O cadastro de pessoas e a atualização de fotos são realizados pelos SDKs, com captura facial e prova de vida. Consulte o guia da sua plataforma: Web, Android, iOS, .NET MAUI, Flutter ou React Native.

Autenticação

Cabeçalho	Descrição
x-apikey	UUID do cliente, disponível em Configurações → Credencial SDK.
x-apisecret	Secret da credencial ativa.

O secret deve ser mantido exclusivamente no servidor.

Listar pessoas

POST https://api.biotrust.io/api/v1/facematch/list
Content-Type: application/json
x-apikey: {uuid-do-cliente}
x-apisecret: {secret-da-credencial}

{ "skip": 0, "take": 50 }

Campo	Tipo	Descrição
skip	int	Quantidade de registros a ignorar.
take	int	Quantidade de registros a retornar.

Os registros são ordenados do cadastro mais recente para o mais antigo.

Resposta

{
  "persons": [
    {
      "uniqueID": "8b2f6c1e-4a7d-4f0e-9c3b-2d5e7a9f1b04",
      "name": "Maria Silva",
      "document": "12345678901",
      "documentType": 0,
      "avatarUrl": "https://…",
      "createdAt": "2026-09-10T14:22:05"
    }
  ]
}

Campo	Tipo	Descrição
uniqueID	string	Identificador da pessoa.
name	string	Nome.
document	string	Documento.
documentType	int	0 CPF, 1 RG, 2 CNH.
avatarUrl	string	URL temporária da foto cadastrada.
createdAt	string	Data do cadastro.

As respostas incluem o objeto transaction, com o resultado da operação.

Excluir pessoa

DELETE https://api.biotrust.io/api/v1/facematch/delete/{uniqueId}
x-apikey: {uuid-do-cliente}
x-apisecret: {secret-da-credencial}

Parâmetro	Local	Descrição
uniqueId	Rota	Identificador da pessoa.

A exclusão remove também a foto cadastrada e gera o evento de webhook facematch.person.deleted.

Exemplos

cURL

curl -X POST "https://api.biotrust.io/api/v1/facematch/list" \
  -H "Content-Type: application/json" \
  -H "x-apikey: $BIOTRUST_UUID" \
  -H "x-apisecret: $BIOTRUST_SECRET" \
  -d '{ "skip": 0, "take": 50 }'

curl -X DELETE "https://api.biotrust.io/api/v1/facematch/delete/8b2f6c1e-4a7d-4f0e-9c3b-2d5e7a9f1b04" \
  -H "x-apikey: $BIOTRUST_UUID" \
  -H "x-apisecret: $BIOTRUST_SECRET"

C#

using System.Net.Http.Json;

var http = new HttpClient { BaseAddress = new Uri("https://api.biotrust.io/") };
http.DefaultRequestHeaders.Add("x-apikey", Environment.GetEnvironmentVariable("BIOTRUST_UUID"));
http.DefaultRequestHeaders.Add("x-apisecret", Environment.GetEnvironmentVariable("BIOTRUST_SECRET"));

var resposta = await http.PostAsJsonAsync("api/v1/facematch/list", new { skip = 0, take = 50 });
var conteudo = await resposta.Content.ReadAsStringAsync();

await http.DeleteAsync("api/v1/facematch/delete/8b2f6c1e-4a7d-4f0e-9c3b-2d5e7a9f1b04");

Node.js

const headers = {
  "x-apikey": process.env.BIOTRUST_UUID,
  "x-apisecret": process.env.BIOTRUST_SECRET,
};

const lista = await fetch("https://api.biotrust.io/api/v1/facematch/list", {
  method: "POST",
  headers: { ...headers, "Content-Type": "application/json" },
  body: JSON.stringify({ skip: 0, take: 50 }),
}).then((resposta) => resposta.json());

await fetch(`https://api.biotrust.io/api/v1/facematch/delete/${lista.persons[0].uniqueID}`, {
  method: "DELETE",
  headers,
});