English
Getting Started

Introduction

The PixToPay KYC API offers different integration methods to meet your project's needs:

1. IFrame Integration (Recommended)

The simplest integration method is through our iframe, which already includes the complete KYC interface and flow. To use the iframe, you have two options:

Option A: Generate link directly (Fastest)

You can generate a link for the iframe without needing to pre-register. The generated link can be used directly in the iframe.

Option B: Register and use the UUID

Alternatively, you can register through the /customer/register endpoint (see the "Customer Registration" section below) and use the onboarding_id (UUID) returned in the iframe link template.

Iframe link format:

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

Implementation Examples

We provide example projects on GitHub to facilitate your integration:

React:

Plain HTML:

Refer to the README of each project for detailed examples on how to implement the iframe call.