Obter foto cadastrada

Recupera a foto de uma pessoa cadastrada no FaceMatch a partir do número do documento.

O endpoint retorna a imagem no formato em que foi cadastrada.

Destinado a integrações servidor a servidor, como relatórios, conferência manual e integração com sistemas internos. Para exibição em tela, utilize as URLs temporárias retornadas na listagem de pessoas.

Requisição

GET https://api.biotrust.io/api/v1/facematch/photo/{documento}
x-apikey: {uuid-do-cliente}
x-apisecret: {secret-da-credencial}

Parâmetros

Parâmetro	Local	Descrição
documento	rota	Documento da pessoa cadastrada. Pontuação é ignorada.
x-apikey	cabeçalho	UUID do cliente, disponível em Configurações → Credencial SDK.
x-apisecret	cabeçalho	Secret da credencial ativa.

Resposta

Em caso de sucesso, o corpo é a própria imagem, com Content-Type correspondente ao formato armazenado (image/png ou image/jpeg).

Código	Situação
200	Imagem retornada.
401	Credencial ausente ou inválida.
404	Não há pessoa cadastrada com este documento, ou a imagem não está disponível.

Escopo da consulta

A consulta é restrita às pessoas cadastradas na conta do cliente.

Exemplos

cURL

curl -X GET "https://api.biotrust.io/api/v1/facematch/photo/12345678900" \
  -H "x-apikey: $BIOTRUST_UUID" \
  -H "x-apisecret: $BIOTRUST_SECRET" \
  --output foto.png

C#

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-apikey", uuidDoCliente);
client.DefaultRequestHeaders.Add("x-apisecret", secret);

var resposta = await client.GetAsync(
    $"https://api.biotrust.io/api/v1/facematch/photo/{documento}");

if (resposta.IsSuccessStatusCode)
{
    var imagem = await resposta.Content.ReadAsByteArrayAsync();
    await File.WriteAllBytesAsync("foto.png", imagem);
}

Node.js

const resposta = await fetch(
  `https://api.biotrust.io/api/v1/facematch/photo/${documento}`,
  { headers: { 'x-apikey': uuidDoCliente, 'x-apisecret': secret } }
);

if (resposta.ok) {
  const imagem = Buffer.from(await resposta.arrayBuffer());
  await fs.promises.writeFile('foto.png', imagem);
}

Dado biométrico

A resposta contém imagem facial. Não armazene a resposta em cache e trate o arquivo conforme a política de retenção de dados da sua organização.