CONTRATO.CLOUD / KYC

API KYC: da identificação ao resultado

Entenda a arquitetura da integração KYC, a jornada hospedada, os eventos e as responsabilidades do seu sistema.

Nesta página

Um fluxo, três responsabilidades

Seu servidor cria uma transação pela API. A pessoa realiza a verificação na jornada hospedada, acessada pelo link retornado. Seu sistema consulta o resultado e recebe eventos para continuar o processo de negócio.

  1. Criar: use POST /v1/face-auth/transactions com X-API-Key no seu backend.
  2. Encaminhar: utilize a URL retornada; a chave nunca vai para o navegador da pessoa.
  3. Acompanhar: associe transaction_id ao seu processo, valide webhooks e reconcilie o estado por GET.

O que o resultado representa

A verificação de identidade é uma etapa do seu fluxo. Aprovar uma identidade não aprova automaticamente crédito, uma compra, uma conta ou poderes de representação. Seu sistema continua responsável pelas regras comerciais, pelo tratamento de pendências e pela decisão de continuidade.

status descreve a etapa operacional; decision informa pending, approved ou rejected. Não transforme uma etapa intermediária em aprovação. Uma jornada expirada também exige tratamento específico.

Escolha como começar

Para compreender o fluxo sem credenciais ou dados pessoais, use o simulador local. Para integrar seu backend, siga o início rápido e consulte a referência.

Os exemplos usam dados sintéticos e um endereço reservado para documentação. A URL de API, as credenciais e os acessos do seu ambiente são definidos na habilitação da integração.

Baixar Markdown

Ambiente protegido