Visão geral da API Reference

Tudo o que você precisa para ir do zero ao seu primeiro humanToken.

Markdown

O Human Token possui três endpoints. Esta página mostra como eles se encaixam para que você possa começar a integrar imediatamente.

URL base

Ambiente	URL base
Produção	https://humantoken.unico.app

Todas as requisições exigem o header x-unico-accesskey. Consulte Autenticação para gerar sua chave.

---

Fluxo de início rápido

---

Etapa 1 — Autenticação

Gere seu x-unico-accesskey no Human Dashboard ou pela Authentication API. Todas as requisições abaixo usam essa chave.

x-unico-accesskey: uip_ak.prod.a1b2c3d4.e5f6g7h8.i9j0k1l2

---

Etapa 2 — Criar um processo

Chame Create Process para iniciar a verificação. Escolha um dos dois modelos:

Modelo	Flows	Como funciona
API Only	api+humantoken, api+liveness+humantoken, api+liveness+humantoken+revalidation	Seu backend envia o selfie como imageBase64. O humanToken retorna na mesma resposta.
Human Token Journey	humantoken, humantoken+revalidation	O usuário completa a captura na plataforma Unico. Você recebe um token e um link para apresentar a jornada, e então obtém o resultado com Get Process.

Exemplo API Only:

curl -X POST https://humantoken.unico.app/client/v1/process \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "flow": "api+humantoken",
    "imageBase64": "<base64-encoded-selfie>",
    "companyBranchId": "<your-branch-id>"
  }'

Exemplo Human Token Journey:

curl -X POST https://humantoken.unico.app/client/v1/process \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "flow": "humantoken",
    "callbackUri": "https://yourapp.com/callback",
    "companyBranchId": "<your-branch-id>"
  }'

Consulte Create Process para todos os flows, parâmetros e detalhes da resposta.

---

Etapa 3 — Apresentar a jornada ao usuário (somente flows Journey)

Para os flows humantoken e humantoken+revalidation, a resposta do Create Process inclui:

• token — inicializa o Web SDK ou a integração nativa
• link — URL para redirecionar o usuário

Escolha a integração adequada para sua plataforma:

Plataforma	Abordagem
Web — SDK	Incorpore a jornada inline com idpay-b2b-sdk → Web Integration
Web — Redirect	Redirecione o usuário para link → Web Integration
Android	Custom Tabs → Android
iOS	ASWebAuthenticationSession → iOS
Ionic	Capacitor plugin → Ionic
React Native	Native module → React Native
Flutter	Platform Channels → Flutter

Quando a jornada termina, o usuário retorna à sua callbackUri. Prossiga para a Etapa 4.

Flows API Only

Pule esta etapa — o resultado já está na resposta do Create Process.

---

Etapa 4 — Obter o resultado (somente flows Journey)

Chame Get Process com o id do processo para obter o resultado:

curl https://humantoken.unico.app/client/v1/process/$PROCESS_ID \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY"

A resposta inclui data.humanToken.value (flows padrão) ou data.humanTokenMatch (flows de revalidação). Consulte Get Process para o esquema completo da resposta e os valores de estado.

---

Etapa 5 — Usar o humanToken

O humanToken é um identificador estável e opaco (até 100 caracteres). A mesma pessoa sempre resolve para o mesmo valor.

const { humanToken } = process.data;

if (!humanToken?.value) {
  // Inconclusive — retry or reject per your business rules
  return;
}

const existing = await db.persons.findByHumanToken(humanToken.value);

if (existing) {
  // Same person seen before — returning user or duplicate
} else {
  // First time — create a new record
  await db.persons.create({ humanToken: humanToken.value });
}

aviso

Sempre verifique se data.humanToken.value não está vazio antes de armazená-lo ou compará-lo.

---

Etapa 6 — Obter o selfie (opcional)

Chame Get Selfie para baixar a imagem capturada. O selfie fica disponível por 24 horas após o término do processo — depois disso, é excluído permanentemente.

curl https://humantoken.unico.app/client/v1/process/$PROCESS_ID/selfie \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY"

Consulte Get Selfie para detalhes da resposta e códigos de erro.

---

Endpoints resumidos

Método	Endpoint	Descrição
POST	/client/v1/process	Create Process — iniciar uma verificação
GET	/client/v1/process/{processId}	Get Process — obter o resultado
GET	/client/v1/process/{processId}/selfie	Get Selfie — baixar o selfie (24 h)

Próximos passos

• Create Process — referência completa de parâmetros para os cinco flows
• Authentication — gerar e gerenciar suas chaves de acesso
• Build With LLM — cole um prompt no seu assistente de IA para gerar a integração completa