Onboarding & KYC Flow

This module covers the end-to-end process of registering new users and verifying their identity. It guides you through account creation, document submission (via API or Hosted Page), and final account activation.

Key stages included in this flow:

User Registration: Creating the base account.

Identity Verification (KYC): Submitting identity documents via one of two methods.

Finalization: Triggering the verification review.

Proof of Address (POA): A conditional step required only for specific jurisdictions.

Core Endpoints

Create User Account

Step 1: Initiates the process by creating a new user account. Returns the poaRequired status.

Add User Verification

Final Step: Submits all data for review. Required to finalize both Hosted and API flows.

Add POA File

Conditional: Upload Proof of Address only if required by the user's country response.

Method A: Hosted Verification

Choose this method if you want P100 to handle document collection via a secure, hosted page.

Create KYC Verification

Initialize a hosted verification session.

Redirect to Verification

Generate the URL to redirect the user to.

Get KYC Status

Check the status of the hosted session.

Method B: API File Upload

Choose this method if you collect documents in your own UI (White Label solution).

Add KYC File

Upload the user's identity document directly via API.

Typical Workflows

Select the verification method that best fits your integration model.

1. Registration (Common Start)

Every flow begins with Create User Account.

Important: Pay attention to the poaRequired flag in the response. It determines if you will need to upload a Proof of Address document in Step 3.

2. Identity Verification (Choose Method)

Method A: Hosted Verification (P100 Page)

Use this flow to offload the UI work to P100.

Call Create KYC Verification to start a session.

Call Redirect to Verification to get the link and redirect your user.

(Optional) Poll Get KYC Status to see if the user completed the steps.

Finalize: Once the user finishes on the hosted page, call Add User Verification to lock the data and start the review.

Method B: API File Upload (White Label)

Use this flow if you have your own mobile/web UI for scanning documents.

Collect the document (ID Card/Passport) in your app.

Upload it using Add KYC File.

Finalize: Call Add User Verification to submit the uploaded files for review.

3. Proof of Address (Conditional)

If the Create User Account response indicated that POA is required (or if specific features require it):

Wait for the identity verification to be initialized (after calling Add User Verification).

Upload the document via Add POA File.

Proof of Address (POA) Details

Proof of Address confirms the user's current residential address. It is a regulatory requirement for users in specific countries.

When is POA required?

The API indicates this requirement during account creation with: "poaRequired": true.

You can also check the list of Supported Countries to see which jurisdictions enforce POA.

Document Requirements

Must show the user’s full name and current address.

Must be recently issued (typically within the last 3 months).

Must be legible and valid.

Commonly Accepted Documents

Utility bill (electricity, water, gas, internet).

Bank statement.

Government-issued official letter.

Tax bill.

Onboarding & KYC Flow

Onboarding & KYC Flow#

Core Endpoints#

Method A: Hosted Verification#

Method B: API File Upload#

Typical Workflows#

1. Registration (Common Start)#

2. Identity Verification (Choose Method)#

Method A: Hosted Verification (P100 Page)#

Method B: API File Upload (White Label)#

3. Proof of Address (Conditional)#

Proof of Address (POA) Details#

Onboarding & KYC Flow

Core Endpoints

Method A: Hosted Verification

Method B: API File Upload

Typical Workflows

1. Registration (Common Start)

2. Identity Verification (Choose Method)

Method A: Hosted Verification (P100 Page)

Method B: API File Upload (White Label)

3. Proof of Address (Conditional)

Proof of Address (POA) Details