v1

latestOpenAPI 3.0.32026-07-26184851.6 MB
Customer Onboarding

List Customer Onboarding Requests

Lists onboarding requests created for a customer.

get/v1/customers/{customerId}/onboarding-requests

Path parameters

customerIdstring uuid required

Customer identifier.

Query parameters

pageinteger

One-based page number.

limitinteger

Number of records per page.

status'draft' | 'collecting_information' | 'ready_for_submission' | 'submitted' | 'action_required' | 'pending_admin_review' | 'in_review' | 'approved' | 'rejected' | 'failed' | 'expired'
providerIdstring uuid
feature'offramp' | 'onramp_payment_order' | 'onramp_virtual_account'

Response

Customer onboarding requests fetched.

statusCodeinteger required
messagestring required