Catalisa.Building Blocks
Catálogo/Biometrics/API

API do Biometrics

33 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 →

33 endpoints

Sessões

/biometrics/api/v1/sessions7
  • POST/biometrics/api/v1/sessionsAbre a sessão e devolve o handoffBIOMETRICS_VERIFY
  • GET/biometrics/api/v1/sessionsListaBIOMETRICS_READ
  • GET/biometrics/api/v1/sessions/:idO envelope completoBIOMETRICS_READ
  • GET/biometrics/api/v1/sessions/:id/evidenceHashes e assinaturaBIOMETRICS_READ
  • GET/biometrics/api/v1/sessions/:id/evidence/verifyConfere a assinatura no servidorBIOMETRICS_READ
  • POST/biometrics/api/v1/sessions/:id/cancelCancelaBIOMETRICS_VERIFY
  • POST/biometrics/api/v1/sessions/:id/capturesSubmissão por SDK próprio, com o captureTokentoken

Captura e convite (públicas, por token)

/biometrics8
  • GET/biometrics/capture/:tokenA página de capturatoken
  • GET/biometrics/capture/:token/stateEstado da sessão, para a páginatoken
  • GET/biometrics/capture/:token/logoO logo da empresatoken
  • GET/biometrics/capture/:token/guide/:nameArquivos do guia ao vivo, com hash fixotoken
  • POST/biometrics/capture/:token/submitO vídeo e a telemetriatoken
  • POST/biometrics/api/v1/invitesCria um link de conviteBIOMETRICS_ADMIN
  • GET/biometrics/invite/:tokenA página do convitetoken
  • POST/biometrics/invite/:token/startAbre uma sessão a partir do convitetoken

Cadastro facial

/biometrics/api/v1/enrollments4
  • POST/biometrics/api/v1/enrollmentsCria o cadastro a partir de uma sessão aprovadaBIOMETRICS_ENROLL
  • GET/biometrics/api/v1/enrollments/:idMetadados do cadastro, nunca o vetorBIOMETRICS_READ
  • DELETE/biometrics/api/v1/enrollments/:idRevogaBIOMETRICS_ENROLL
  • POST/biometrics/api/v1/enrollments/rekeyRecifra os cadastros com a chave novaBIOMETRICS_ADMIN

Evidência e direitos do titular

/biometrics/api/v14
  • GET/biometrics/api/v1/evidence-keysChaves públicas Ed25519 da organizaçãoBIOMETRICS_READ
  • POST/biometrics/api/v1/evidence-keys/rotateGira a chave de assinaturaBIOMETRICS_ADMIN
  • POST/biometrics/api/v1/subjects/reportO que existe sobre um CPF (LGPD art. 18)BIOMETRICS_ADMIN
  • POST/biometrics/api/v1/subjects/eraseApaga os dados biométricos de um CPFBIOMETRICS_ADMIN

Fornecedores, política e consumo

/biometrics/api/v110
  • POST/biometrics/api/v1/providersCadastra o fornecedorBIOMETRICS_ADMIN
  • GET/biometrics/api/v1/providersListaBIOMETRICS_READ
  • GET/biometrics/api/v1/providers/:idDetalheBIOMETRICS_READ
  • PATCH/biometrics/api/v1/providers/:idAtualiza, inclusive a aparênciaBIOMETRICS_ADMIN
  • DELETE/biometrics/api/v1/providers/:idRemoveBIOMETRICS_ADMIN
  • POST/biometrics/api/v1/providers/:id/test-connectionTesta o motor ou a credencialBIOMETRICS_ADMIN
  • GET/biometrics/api/v1/policyA política da organizaçãoBIOMETRICS_READ
  • PUT/biometrics/api/v1/policyTroca a políticaBIOMETRICS_ADMIN
  • GET/biometrics/api/v1/catalogDrivers, capacidades e garantia de cada umBIOMETRICS_READ
  • GET/biometrics/api/v1/usageConsumo por períodoBIOMETRICS_READ