Overview
The onboarding process involves:- Creating a customer record (KYB automatically initiated)
- Redirecting customer to complete verification
- Monitoring KYB status via API or webhooks
Step 1: Create a Customer
First, create a customer record with basic business information.Customer Creation Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
name | string | ✅ | Legal name of the business or individual | "Acme Corp" |
customer_type | string | ✅ | Type of customer account. Must be "business" or "individual" | "business" |
external_id | string | ❌ | Your internal identifier for this customer | "acme_001" |
Request Example
cURL
JavaScript
Python
Go
Rust
Java
Step 2: KYB Process (Automatic)
The KYB onboarding process is automatically initiated when you create a customer. You don’t need to make additional API calls to start KYB verification.Automatic KYB Initiation
When you create a customer, the system automatically:- Generates a KYB onboarding link with Persona (our default provider)
- Returns the onboarding URL in the
kyb_linksarray - Sets the initial KYB status to
"pending"
KYB Response Details
The customer creation response includes:| Field | Description | Example |
|---|---|---|
kyb_links | Array of KYB provider information and onboarding links | See below |
kyb_status | Current verification status | "pending" |
KYB Links Structure
Each item in thekyb_links array contains:
| Field | Description | Example |
|---|---|---|
provider_id | KYB provider name | "dakota" |
link_type | Type of KYB link | "kyb_onboarding" |
url | Onboarding URL for customer | "https://withpersona.com/verify?inquiry-id=inq_abc123" |
status | Link status | "pending" |
created_at | Link creation timestamp | 1705320600 |
updated_at | Link last updated timestamp | 1705320600 |
Using the KYB Link
From the customer creation response, extract the onboarding URL:Step 3: Handle the Onboarding Flow
Direct your customer to the onboarding URL (from thekyb_links array) to complete verification. The customer will:
- Provide business documentation
- Verify business identity
- Complete compliance checks
- Receive approval or additional requirements
Step 4: Monitor KYB Status
Check onboarding status programmatically:cURL
JavaScript
Python
Go
Rust
Java
KYB Status Values
| Status | Description |
|---|---|
not_started | Onboarding not yet started |
in_progress | Customer is completing verification |
in_review | Provider is reviewing submission |
approved | Verification successful |
rejected | Verification failed |
requires_info | Additional information needed |
frozen | Account suspended or frozen |
Best Practices
User Experience
- Clearly communicate the onboarding requirements
- Provide progress indicators
- Set expectations for processing time
- Offer support contact information
Error Handling
- Handle rejection gracefully
- Provide clear next steps
- Allow customers to restart if needed
- Log all onboarding events
Compliance
- Store audit trails
- Monitor for suspicious activity
- Keep records for compliance reporting
- Regular review of rejected applications
Required Documents
Typical documents required for business verification:- Certificate of Incorporation
- Bank Statements
- Director/Officer Identification
- Beneficial Ownership Information
Troubleshooting
Common Issues
Onboarding Stuck in “Pending”- Check if customer has accessed the onboarding URL
- Ensure document quality meets requirements
- Consider manual review process
- Verify webhook endpoint is responding with 200
- Check webhook signature validation
- Review webhook logs in dashboard
Next Steps
After successful customer onboarding:- Set up Recipients & Destinations - Configure payment targets
- Create Transactions - Process payments for approved customers
- Webhook Integration - Get real-time KYB status updates
- Testing - Test your onboarding flow
API Reference
For detailed endpoint documentation, see:- Customers API Reference - Customer creation and management
- KYB Providers API Reference - KYB initiation and status checking
- Webhooks API Reference - Real-time onboarding notifications