Documentação

Identity API — Referência técnica.

REST API para embarcar biometria forense, assinatura avançada e emissão de credenciais SD-JWT diretamente no seu produto. Integração em até 11 dias.

Visão Geral

O que a Identity API oferece.

Verificação biométrica

Endpoint de liveness 3D com retorno de score, template biométrico e resultado de cruzamento com bases oficiais

Emissão de credenciais SD-JWT

Geração de credenciais verificáveis com revelação seletiva, compatíveis com eIDAS 2 e Drex

Assinatura e Dossiê

Fluxo completo de assinatura com carimbo RFC 3161 e geração de laudo pericial PDF/A + JSON

Webhooks e notificações

Eventos em tempo real para cada etapa do fluxo de assinatura — signed, rejected, expired

Autenticação

Bearer Token + mTLS.

Todas as requisições à Identity API requerem autenticação via Bearer Token (OAuth 2.0 Client Credentials) com TLS 1.3 obrigatório. Clientes enterprise podem habilitar mTLS (mutual TLS) para autenticação bidirecional.

ProtocoloOAuth 2.0 Client Credentials
TransportTLS 1.3 obrigatório
mTLSDisponível para enterprise
Token TTL3600 segundos (renovável)
Request
POST /v1/auth/tokenContent-Type: application/json{  "client_id": "seu_client_id",  "client_secret": "seu_client_secret",  "grant_type": "client_credentials"}
RESPONSE
200 OK
{  "access_token": "eyJ...",  "token_type": "Bearer",  "expires_in": 3600}
Endpoints

Principais rotas.

POST/v1/identity/verify

Inicia o fluxo de verificação biométrica 3D Liveness. Retorna session_id para acompanhamento em tempo real.

GET/v1/identity/{session_id}

Consulta resultado da verificação — status, score de liveness e dados cruzados com bases oficiais.

POST/v1/sign/create

Cria envelope de assinatura com documento, signatários e configuração de fluxo.

GET/v1/sign/{envelope_id}/dossie

Recupera o Dossiê Pericial completo em PDF/A e JSON com cadeia de custódia.

POST/v1/credentials/issue

Emite credencial SD-JWT verificável com revelação seletiva para a Wallet do usuário.

Documentação completa de parâmetros, request body e response schemas disponível para clientes via portal developer.

SDKs

Bibliotecas disponíveis.

JS
Disponível
JavaScript / TypeScriptnpm install @mypass/identity-sdk
PY
Disponível
Pythonpip install mypass-identity
JK
Em breve
Java / KotlinPrevisão: Q3 2026
RN
Em breve
Mobile (React Native)Previsão: Q3 2026
Integração

Pronto para integrar?

Nosso time de arquitetura acompanha sua integração do primeiro endpoint ao go-live.