PixFace IFrame

PixFace IFrame

O PixFace oferece uma integração simples via iframe, permitindo incorporar o fluxo completo de verificação KYC diretamente em sua aplicação web.

Implementação

Para utilizar o iframe, adicione o código abaixo em sua página, substituindo <ONBOARDING_ID> pelo ID de onboarding obtido através do:

  • Dashboard PixFace
  • PixFace SDK
  • API REST
<iframe
  src="https://kyc.pixtopay.com/?guid=<ONBOARDING_ID>}"
  onMessage={(event) => {
    if (event.data.type === "stepUpdate") {
      console.log("Etapa:", event.data.step);
    }
  }}
/>

Captura de Eventos

O iframe comunica eventos ao host através do atributo onMessage. Você pode capturar os diferentes tipos de eventos conforme mostrado no exemplo acima.

Eventos Disponíveis

stepUpdate

Emitido quando o usuário avança para uma nova etapa do processo.

{
  type: "stepUpdate",
  step: number
}

processCompleted

Emitido quando o processo de verificação é finalizado.

{
  type: "processCompleted",
  status: "approved" | "rejected" | "pending",
  reason?: string
}

Possíveis status:

  • approved: Verificação aprovada
  • rejected: Verificação rejeitada
  • pending: Verificação em análise manual

O campo reason é opcional e fornece detalhes adicionais quando aplicável.