Começando agora

Introdução

A API KYC PixToPay oferece diferentes formas de integração para atender às necessidades do seu projeto:

1. Integração via iframe (Recomendado)

A forma mais simples de integração é através do nosso iframe, que já possui toda a interface e fluxo de KYC prontos. Para utilizar o iframe, você tem duas opções:

Opção A: Gerar link diretamente (Mais Rápido)

Você pode gerar um link para o iframe sem precisar fazer o pré-registro. O link gerado já pode ser utilizado diretamente no iframe.

Opção B: Fazer registro e usar o UUID

Alternativamente, você pode fazer o registro através do endpoint /customer/register (consulte a seção "Registro do Cliente" abaixo) e utilizar o onboarding_id (UUID) retornado no template do link do iframe.

Formato do link do iframe:

https://kyc-front.pixtopay.com.br/?onboarding_id=<ONBOARDING_ID>

Exemplos de Implementação

Disponibilizamos projetos de exemplo no GitHub para facilitar sua integração:

React:

HTML Puro:

Consulte o README de cada projeto para ver exemplos detalhados de como implementar a chamada do iframe.