Partner API
test
  • latest
  • test
  1. User Operations
Partner API
test
  • latest
  • test
  • Getting Started
    • Introduction
    • Authentication
    • Business Use Cases
  • API References
    • Partner Operations
      • Balances & Transaction History
        • Get Balances
        • Get Transaction History
        • Create Wallet
        • Create transfer master balance
      • Exchange Operations
        • Retrieve Exchange Rate
        • Create and Finalize an Exchange
        • Retrieve Detailed Exchange Information
        • Retrieve Exchange Rate and Create a Lock
      • SEPA Transfers
      • Crypto Deposits
        • Update Travel Rule
      • Crypto Withdrawal
        • Get Crypto Withdrawal Details
        • Create Crypto Withdrawal
      • Orders
        • Retrieve Order Rate and Create a Lock
        • Create and Finalize an Order
        • Get Order Details
        • Get Rates
      • Payment link
        • Generate Payment Link
        • Get Payment Link Details
    • User Operations
      • Onboarding & KYC Flow
        • Create User Account
        • Method A: Add KYC File
        • Method B: Creating KYC Verification
        • Method B: Redirect to Verification
        • Method B: Get KYC Status
        • Add User Verification
        • Add POA File
      • Account Management
        • Update Existing User
        • Delete User
        • Suspend User
        • Unsuspend User
      • Balances & Transaction History
        • Get User Balances
        • Get User Transaction History
      • Currency Exchange
        • Retrieve Exchange Rate
        • Retrieve Exchange Rate and Create a Lock
        • Create and Finalize an Exchange
        • Retrieve Detailed Exchange Information
      • Internal Transfers
        • Create a Transfer
        • Get Transfer Details
      • Virtual Cards
        • Create Virtual Card
        • Get All User Cards
        • Get Card Details
        • Update Card PIN
        • Block Card
        • Unblock Card
        • Get Card Limits
        • Update Card Limits
        • Delete Card
      • Crypto Deposits
        • Update Travel Rule
      • Crypto Withdrawals
        • Get Network Fee
        • Create Crypto Withdrawal
        • Get Crypto Withdrawal Details
      • SEPA Transfers Copy
  • Integration
    • SDKs & Integration Guides
    • Transaction Processing
    • Error Handling
    • Rate Limiting
    • Webhooks
      • User & KYC Webhooks
        • User Balance Generation Webhook
        • KYC File Added Webhook
        • POA Verification Status Webhook
        • KYC Verification Status Webhook
        • Create Wallet Webhook
      • Transfers & Payments Webhooks
        • P2P Transfer Webhook
        • SEPA Transfer Webhook
        • SEPA Deposit Webhook
        • Crypto Withdrawal Webhook
        • Crypto Deposit Webhook
        • Exchange Webhook
        • Card Transaction Webhook
        • Order status Webhook
        • Payment Link Webhook
      • Card Webhooks
        • Card 3DS Code Webhook
        • Card Activation Code Webhook
  • Reference
    • Supported Countries
    • Supported Currencies
    • Fees
    • FAQ
    • Changelog
    • Support
  1. User Operations

Onboarding & KYC Flow

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:
1.
User Registration: Creating the base account.
2.
Identity Verification (KYC): Submitting identity documents via one of two methods.
3.
Finalization: Triggering the verification review.
4.
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.
1.
Call Create KYC Verification to start a session.
2.
Call Redirect to Verification to get the link and redirect your user.
3.
(Optional) Poll Get KYC Status to see if the user completed the steps.
4.
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.
1.
Collect the document (ID Card/Passport) in your app.
2.
Upload it using Add KYC File.
3.
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):
1.
Wait for the identity verification to be initialized (after calling Add User Verification).
2.
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.
Previous
Get Payment Link Details
Next
Create User Account
Built with