Partner Onboarding

Get Application Status

Get the onboarding status of an application, including uploaded documents and the applicant's KYC status.

get/partner/applications/{app_id}

Request

Path parameters

app_idstring required

The onboarding application, as returned when it was created.

Response

Successful Response

entity_idstring uuid required

Public ID of the onboarded business entity, stable across the onboarding lifecycle and matching the entity_id used in the Customer API, MCP, and webhook payloads.

status'pending_document_upload' | 'pending_user_action' | 'submitted' | 'under_review' | 'approved' | 'rejected' required
business_namestring nullable required

Legal business name.

created_atstring date-time required

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

updated_atstring date-time required

ISO 8601 date-time in the format YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm] (per IETF RFC 3339).

kyc_status'not_started' | 'pending' | 'action_required' | 'approved' | 'rejected' required
application_idstring uuid required

Unique application identifier.

partner_reference_idstring nullable required

Your reference ID.

onboarding_urlstring required

URL the applicant opens to complete onboarding.

Changes

No recorded changes to this operation across all 1 revision of this API.