Skip to main content

​
Submit client KYB

Use this guide when a partner must complete Know Your Business (KYB) for an end-customer before regulated products (Pay, Payroll disbursement, etc.) are enabled. Partner-mediated KYB is reviewed in a separate queue from direct-tenant KYB.

​
Prerequisites

  • Client company created under a workspace — Onboard a client company
  • Company profile fields complete (name, country, currency, registration details)
  • Documents collected from the merchant offline or via your product

​
Overview

1

Partner collects documents

Gather registration certificates, ID copies, and any jurisdiction-specific files from the merchant.
2

Partner uploads via Connect API

Attach files to the client company KYB state.
3

Partner submits for review

POST .../kyb/submit moves the case to the platform Partner KYB queue.
4

Platform reviews

Approve or reject with notes returned to the partner only — relay outcomes to your client.
Your firm KYB (the SERVICE_PARTNER organization) uses org onboarding routes (/api/v1/onboarding/kyb/*). Client KYB uses workspace company routes below.

​
Steps

1

Check current KYB state

Review required document types and current status.
2

Upload documents

Upload each required file per the KYB requirements returned in the state payload. Use the document upload endpoints on the company KYB resource — see Auth API reference under workspace company KYB operations.
3

Submit for review

4

Poll status and relay to client

Re-fetch KYB state until status is APPROVED or REJECTED. Notes are visible to your partner org — communicate results to the merchant through your own product.

​
Tips

  • Complete the company profile before submit — incomplete registration data is a common rejection reason.
  • Keep a mapping from your merchant ID to companyId so you can poll KYB status from your admin dashboard.
  • Approved client KYB unlocks wallet and disbursement flows for that companyId under acting-client headers.

​
Troubleshooting

Onboard a client company

Create the company before KYB.

Multi-tenancy

Partner tenancy model and API tables.