Integracao via Web
A integracao Web usa sessao criada pelo parceiro e um redirecionamento para o fluxo hospedado da Puerix.
Visao do fluxo
- Seu backend cria a sessao via
POST /v1/sessions. - Seu frontend redireciona o usuario para a URL de verificacao web da Puerix.
- A Puerix executa liveness e, se necessario, etapa de documento.
- Ao final, o usuario retorna para
callback_urloucancel_url. - Seu backend consulta
GET /v1/sessions/:idpara confirmar resultado final.
Passo a passo
Antes de iniciar, obtenha suas credenciais no painel em https://www.puerix.com/dashboard:
tenant_id: exibido no bloco Tenant ID.apiKey: exibida no bloco Chave de API.
1. Criar sessao no backend
Recomendacao: nunca criar sessao direto no frontend. Sempre no backend do parceiro.
Campos mais importantes:
subjectage_limitcallback_urlcancel_urlnotification_url(se quiser webhook)
2. Montar redirecionamento para o fluxo Web Puerix
A URL exata do fluxo web e fornecida pela equipe Puerix no seu onboarding.
No redirecionamento, envie os dados de contexto da sessao gerada. Campos normalmente usados no fluxo:
tenantIdsessionIdsignature
Exemplo ilustrativo:
https://app.puerix.com/start?tenantId=TENANT_ID&sessionId=SESSION_ID&signature=SIGNATURE
3. Tratar retorno no parceiro
Configure:
callback_url: para sucesso/conclusao.cancel_url: para cancelamento.
No retorno, seu backend deve consultar GET /v1/sessions/:id para obter a decisao final oficial (approved ou denied).
Boas praticas
- Nao confie apenas no retorno de navegador para decisao final.
- Sempre confirmar o status via API.
- Definir timeout/retry para consultas em caso de status
processing. - Persistir
sessionIdesubjectpara rastreabilidade.