35 endpoints em 5 recursos. A permissão de cada rota é a que o código exige — conferida linha a linha, não copiada do nome.
Ver a referência detalhada, com corpo de requisição e catálogo de erros →
/biometrics/api/v1/sessions8/biometrics/api/v1/sessionsAbre a sessão e devolve o handoffBIOMETRICS_VERIFY/biometrics/api/v1/sessionsListaBIOMETRICS_READ/biometrics/api/v1/sessions/:idO envelope completoBIOMETRICS_READ/biometrics/api/v1/sessions/:id/evidenceHashes e assinaturaBIOMETRICS_READ/biometrics/api/v1/sessions/:id/evidence/verifyConfere a assinatura no servidorBIOMETRICS_READ/biometrics/api/v1/sessions/:id/evidence/verifyO mesmo, com as expectativas no corpo (use este quando mandar CPF)BIOMETRICS_READ/biometrics/api/v1/sessions/:id/cancelCancelaBIOMETRICS_VERIFY/biometrics/api/v1/sessions/:id/capturesSubmissão por SDK próprio, com o captureTokentoken/biometrics9/biometrics/capture/:tokenA página de capturatoken/biometrics/capture/:token/stateEstado da sessão, para a páginatoken/biometrics/capture/:token/logoO logo da empresatoken/biometrics/capture/:token/guide/:nameArquivos do guia ao vivo, com hash fixotoken/biometrics/capture/:token/documentA foto do documento (multipart image, JPEG/PNG/WebP, até 8 MB), ANTES da selfie, quando a sessão ONBOARDING pediu DOCUMENT_IMAGE sem fileId. Não consome o token. Resposta: { accepted: true } ou o motivo de UX (reference.low_quality, reference.document_subject_unread, reference.document_subject_mismatch, reference.document_expired…) com attemptsLeft; até 5 fotos por sessão. Cada recusa publica biometrics.document.refused, cada aceite biometrics.document.accepted (com o veredito do CPF, nunca o número)token/biometrics/capture/:token/submitO vídeo e a telemetriatoken/biometrics/api/v1/invitesCria um link de conviteBIOMETRICS_ADMIN/biometrics/invite/:tokenA página do convitetoken/biometrics/invite/:token/startAbre uma sessão a partir do convitetoken/biometrics/api/v1/enrollments4/biometrics/api/v1/enrollmentsCria o cadastro a partir de uma sessão aprovadaBIOMETRICS_ENROLL/biometrics/api/v1/enrollments/:idMetadados do cadastro, nunca o vetorBIOMETRICS_READ/biometrics/api/v1/enrollments/:idRevoga. Zera o vetor do cadastro **e** a cópia dele na sessão de origem (state.templateCipher), como a purga de retenção: a mesma sessão não regrava o rosto nas 24 h da janela de cadastro. biometrics.enrollment.revoked leva vectorScrubbed; falha ao limpar a cópia não desfaz a revogação (fica no log, e a purga de mídia apaga depois)BIOMETRICS_ENROLL/biometrics/api/v1/enrollments/rekeyRecifra os cadastros com a chave novaBIOMETRICS_ADMIN/biometrics/api/v14/biometrics/api/v1/evidence-keysChaves públicas Ed25519 da organizaçãoBIOMETRICS_READ/biometrics/api/v1/evidence-keys/rotateGira a chave de assinaturaBIOMETRICS_ADMIN/biometrics/api/v1/subjects/reportO que existe sobre um CPF (LGPD art. 18)BIOMETRICS_ADMIN/biometrics/api/v1/subjects/eraseApaga os dados biométricos de um CPFBIOMETRICS_ADMIN/biometrics/api/v112/biometrics/api/v1/providersCadastra o fornecedorBIOMETRICS_ADMIN/biometrics/api/v1/providersListaBIOMETRICS_READ/biometrics/api/v1/providers/:idDetalheBIOMETRICS_READ/biometrics/api/v1/providers/:idAtualiza, inclusive a aparênciaBIOMETRICS_ADMIN/biometrics/api/v1/providers/:idRemoveBIOMETRICS_ADMIN/biometrics/api/v1/providers/:id/test-connectionTesta o motor ou a credencialBIOMETRICS_ADMIN/biometrics/api/v1/policyA política efetiva (da subconta, se houver override; senão da organização)BIOMETRICS_READ/biometrics/api/v1/policyTroca a política (no escopo de subconta, grava o override dela)BIOMETRICS_ADMIN/biometrics/api/v1/policyRemove o override da subconta do escopoBIOMETRICS_ADMIN/biometrics/api/v1/policy/reapply-retentionReaplica a retenção da política vigente ao que a organização já guarda: estende evidence.retainedUntil (ou o mediaDays do snapshot, sem evidência) e o expiresAt dos cadastros; **nunca encurta**; organização do token (subconta: 403); biometrics.retention.reapplied com as contagensBIOMETRICS_ADMIN/biometrics/api/v1/catalogDrivers, capacidades e garantia de cada umBIOMETRICS_READ/biometrics/api/v1/usageConsumo por período. Com groupBy=day\month, série com total, approved, rejected, inconclusive, expired, cancelled, inProgress e billable por bucket (America/Sao_Paulo) e totals; from, to, subaccountId e environment (live por padrão, test ou all) opcionais