1. User Operations
Partner API
  • Getting Started
    • Introduction
    • Authentication
    • Business Use Cases
  • API References
    • Partner Operations
      • Balances & Transaction History
        • Get Balances
        • Get Transaction History
        • Create Wallet
      • Currency Exchange
        • Retrieve Exchange Rate
        • Retrieve Exchange Rate and Create a Lock
        • Create and Finalize an Exchange
        • Retrieve Detailed Exchange Information
      • SEPA Transfers
        • Get SEPA Deposit Info
        • Get SEPA Deposit Contact List
        • Create a SEPA Transfer
        • Get SEPA Transfer Details
      • Crypto Withdrawal
        • Get Network Fee
        • Create Crypto Withdrawal
        • Get Crypto Withdrawal Details
      • Crypto Deposits
        • Update Travel Rule
      • Orders
        • Get Rates
        • Retrieve Order Rate and Create a Lock
        • Create and Finalize an Order
        • Get Order Details
      • Payment link & Checkout Link
        • Generate Payment Link
        • Generate Hosted Checkout
        • 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
      • SEPA Transfers
        • Get SEPA Deposit Info
        • GET SEPA Deposit Contact List
        • Create a SEPA Transfer
        • Get SEPA Transfer Details
      • Crypto Withdrawal
        • Get Network Fee
        • Create Crypto Withdrawal
        • Get Crypto Withdrawal Details
      • Crypto Deposits
        • Update Travel Rule
      • 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
  • 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
        • High Risk KYC Verification Webhook
      • Transfers & Payments Webhooks
        • Internal Transfer Webhook
        • IBAN Status Webhook
        • Partner SEPA Transfer Webhook
        • User 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

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

Key Stages#

1.
User Registration: Create the base account.
2.
Identity Verification (KYC): Submit identity documents using one of two methods.
3.
Proof of Address (POA): Conditional step required only for specific jurisdictions.
4.
Finalization: Trigger verification review once all required documents are ready.

Core Endpoints#

Create User Account
Initiates the process by creating a new user account. Returns poaRequiredForExtended when the extended POA path is required.
Add User Verification
Submits all data for review. Required to finalize both hosted and API flows.
Add POA File
Upload proof of address only if required by user country response.

Method A: API File Upload#

Choose this method if you collect documents in your own UI (white-label solution).
Add KYC File
Upload user identity document directly via API.

Method B: Hosted Verification#

Choose this method if you want Fintegence to handle document collection via a secure hosted page.
Create KYC Verification
Initialize a hosted verification session.
Redirect to Verification
Generate redirect URL for the user.
Get KYC Status
Check status of hosted verification session.

Typical Workflows#

Select the verification method that best fits your integration model.

1. Registration (Common Start)#

Every flow begins with Create User Account.
POA Flag
Pay attention to poaRequiredForExtended in response. It determines whether you must complete the POA branch before final verification.

2. Identity Verification (Choose Method)#

Method A: API File Upload (White Label)#

Use this flow if you have your own mobile/web UI for collecting documents.
1.
Collect document (ID card/passport) in your app.
2.
Upload file using Add KYC File.
3.
If poaRequiredForExtended is not set to true, finalize by calling Add User Verification to submit files for review.

Method B: Hosted Verification#

Use this flow to offload verification UI to hosted flow.
1.
Call Create KYC Verification to start session.
2.
Call Redirect to Verification to get link and redirect user.
3.
Optionally poll Get KYC Status to monitor completion.
4.
If poaRequiredForExtended is not set to true, finalize by calling Add User Verification to lock data and start review.

3. Proof of Address (Conditional)#

If Create User Account returns poaRequiredForExtended: true:
1.
Complete identity document collection using Method A or Method B.
2.
Upload POA documents via Add POA File.
3.
Wait for POA approval via POA Verification Status Webhook.
4.
Call Add User Verification only after the required POA step is approved.

Proof of Address (POA) Details#

Proof of address confirms user residential address and is a regulatory requirement for specific countries.

When Is POA Required?#

API indicates requirement during account creation with "poaRequiredForExtended": true.
You can also check Supported Countries to see jurisdictions requiring POA.

Document Requirements#

Must include user full name and current address.
Must be recently issued (typically within 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
User Operations
Next
Create User Account
Built with