Documentação

Consultar verificação

Endpoint REST GET /v1/sessions/:verificationId — valide o id e obtenha o mesmo payload do SDK, sem selfieBase64.

Use este endpoint no seu backend para confirmar que um verificationId recebido do frontend é válido e obter o resultado consolidado. A autenticação é via Authorization: Bearer tf_live_… (veja Autenticação).

O campo selfieBase64 não é retornado — ele só existe no callback onResult do SDK, anexado no navegador. Veja Resultado e erros (SDK).

Requisição

GET /v1/sessions/:verificationId
curl https://api.techfaceid.com/v1/sessions/7b5ced4c-678b-4574-8898-62aad1ece852 \
  -H "Authorization: Bearer tf_live_sua_chave"

Parâmetros

ParâmetroDescrição
verificationIdIdentificador retornado em POST /v1/sessions, no onResult do SDK ou em POST /v1/compare.

Resposta

200 OK — concluída
{
  "verificationId": "7b5ced4c-678b-4574-8898-62aad1ece852",
  "type": "liveness_facematch",
  "status": "completed",
  "approved": true,
  "liveness": {
    "isLive": true,
    "confidence": 98.4
  },
  "faceMatch": {
    "matched": true,
    "similarity": 99.1
  },
  "timestamp": "2026-07-15T15:00:00.000Z"
}
200 OK — ainda pendente
{
  "verificationId": "7b5ced4c-678b-4574-8898-62aad1ece852",
  "type": "liveness",
  "status": "pending",
  "approved": null,
  "timestamp": "2026-07-15T14:58:00.000Z"
}

Campos

CampoDescrição
verificationIdId da verificação.
typeliveness, facematch, liveness_facematch ou compare.
statuspending, completed ou failed.
approvedtrue/false quando concluída; null enquanto pending.
livenessPresente quando há resultado de prova de vida: isLive e confidence (%).
faceMatchPresente quando há resultado de comparação: matched e similarity (%).
timestampData/hora ISO 8601 da conclusão (ou da criação, se ainda pendente).

Uso típico no backend

Depois que o SDK chama onResult, envie o verificationId ao seu servidor e consulte a API para confiar no resultado (não aceite só o JSON vindo do navegador):

Exemplo (Node)
const res = await fetch(
  `https://api.techfaceid.com/v1/sessions/${verificationId}`,
  { headers: { Authorization: `Bearer ${process.env.TECHFACE_API_KEY}` } },
);

if (res.status === 404) {
  throw new Error("Verificação inválida");
}

const data = await res.json();
if (data.status !== "completed" || !data.approved) {
  throw new Error("Verificação não aprovada");
}
A consulta é escopada à conta dona da apiKey — qualquer chave ativa da mesma conta pode ler a verificação. Ids de outras contas retornam VERIFICACAO_DE_OUTRA_CONTA.

Erros

CódigoHTTPQuando ocorre
VERIFICACAO_NAO_ENCONTRADA404Id inexistente ou inválido.
VERIFICACAO_DE_OUTRA_CONTA403A verificação pertence a outra conta.
API_KEY_AUSENTE / API_KEY_INVALIDA401Autenticação inválida — veja Erros da API.