Início rápido
Crie a conta, pegue a chave de teste e rode o primeiro fluxo com o motor simulado, sem gastar franquia.
# 1. abra a sessão (documento como referência) curl -X POST https://api.biometrics.catalisa.app/v1/sessions \ -H "Authorization: Bearer $CHAVE_TESTE" \ -d '{ "flow": "ONBOARDING", "purpose": "abertura de conta", "reference": { "source": "DOCUMENT_IMAGE", "fileId": "…" }, "enrollOnApprove": true }'
# 2. mande a pessoa para o link — ou embuta { "captureUrl": "https://biometrics.catalisa.app/c/eyJ…", "challenge": { "script": ["SMILE", "TURN_LEFT", "BLINK"], "slotsMs": [5200, 6100, 4800] }, "expiresAt": "…" }
# 3. a decisão chega no webhook — ou consulte curl https://api.biometrics.catalisa.app/v1/sessions/$ID \ -H "Authorization: Bearer $CHAVE_TESTE" { "status": "APPROVED", "enrollment": { "templateId": "…" } }
Em quatro passos
- Crie a conta
O plano Livre já traz chave de teste e 30 verificações reais por mês.
- Abra uma sessão
POST /v1/sessions com o fluxo e a finalidade; a resposta traz o link de captura.
- Mande a pessoa para a captura
Por link, iframe ou SDK.
- Receba a decisão
Por webhook ou consultando a sessão; o recibo vem junto.
Instale o SDK
Opcional: tudo funciona com HTTP puro, e os exemplos abaixo são assim. O SDK poupa o que é chato de acertar — assinatura do webhook, verificação do recibo, repetição segura e os tipos do envelope.
$ pip install catalisa-biometrics from catalisa_biometrics import Biometrics bio = Biometrics(api_key=os.environ["CATALISA_API_KEY"]) sessao = bio.sessions.create(flow="LIVENESS_ONLY", purpose="abertura de conta") # mande a pessoa para sessao["handoff"]["captureUrl"]
$ composer require catalisa/biometrics use Catalisa\Biometrics\Client; $bio = new Client(apiKey: getenv('CATALISA_API_KEY')); $sessao = $bio->createSession(['flow' => 'LIVENESS_ONLY', 'purpose' => 'abertura de conta']); // mande a pessoa para $sessao['handoff']['captureUrl']
$ go get github.com/catalisaio/catalisa-biometrics-sdk/packages/go bio, _ := biometrics.New(biometrics.Options{APIKey: os.Getenv("CATALISA_API_KEY")}) sessao, err := bio.CreateSession(ctx, biometrics.CreateSessionInput{ Flow: biometrics.FlowLivenessOnly, Purpose: "abertura de conta", }) // mande a pessoa para sessao.Handoff.CaptureURL
$ dotnet add package Catalisa.Biometrics using var bio = new BiometricsClient(Environment.GetEnvironmentVariable("CATALISA_API_KEY")!); var sessao = await bio.CreateSessionAsync(new CreateSessionInput { Flow = Flows.LivenessOnly, Purpose = "abertura de conta", }); // mande a pessoa para sessao.Handoff!.CaptureUrl
$ gem install catalisa-biometrics require "catalisa/biometrics" bio = Catalisa::Biometrics::Client.new(api_key: ENV.fetch("CATALISA_API_KEY")) sessao = bio.create_session(flow: "LIVENESS_ONLY", purpose: "abertura de conta") # mande a pessoa para sessao.dig("handoff", "captureUrl")
$ npm install @catalisa/biometrics # em publicação import { Biometrics } from '@catalisa/biometrics' const bio = new Biometrics({ apiKey: process.env.CATALISA_API_KEY }) const sessao = await bio.sessions.create({ flow: 'LIVENESS_ONLY', purpose: 'abertura de conta' }) // mande a pessoa para sessao.handoff.captureUrl
<!-- Maven: io.github.catalisaio:catalisa-biometrics:0.1.0 --> var bio = BiometricsClient.of(System.getenv("CATALISA_API_KEY")); var sessao = bio.createSession(Map.of( "flow", Models.Flows.LIVENESS_ONLY, "purpose", "abertura de conta")); // mande a pessoa para sessao.handoff().captureUrl()
Kotlin usa o mesmo artefato do Java. Código-fonte, testes e os vetores de assinatura: github.com/catalisaio/catalisa-biometrics-sdk.
1. Abra uma sessão
Do seu servidor, com a chave da sua conta. A resposta traz o link de captura, que vale para uma pessoa e uma sessão.
Carregando o exemplo…
2. Mande a pessoa para a captura
O jeito mais simples é o link: por WhatsApp, e-mail, QR ou um botão no seu app. Iframe e modal estão em Iframe e SDK.
Carregando o exemplo…
3. Receba a decisão no seu servidor
A decisão chega assinada no seu webhook. Confira a assinatura antes de confiar no conteúdo: é o que garante que veio da Catalisa.
Carregando o exemplo…
4. Consulte a sessão quando quiser
O envelope completo, com as verificações, os motivos e o recibo, a qualquer momento pelo id.
Carregando o exemplo…
Três jeitos de mostrar a câmera
Mande o link. Cor, logo e textos da sua marca; pronta para celular e computador.
Dentro do seu app, com eventos de andamento. A decisão nunca passa pelo navegador.
Seu app nativo grava e envia com o mesmo token de uso único.
Documentação completa
A referência de cada rota, os campos do envelope, os eventos e os limites estão em docs.catalisa.app.