Pre-Onboarding

Get registration status

get/api/v1/pre-onboarding/registrations/{registrationId}/status

Request

  • Base URL: https://api-sandbox.koywe.com
  • URL: https://api-sandbox.koywe.com/api/v1/pre-onboarding/registrations/{registrationId}/status
  • Auth: HTTP bearer

Path parameters

registrationIdstring required

Response

idstring required

Pre-onboarding registration ID

status'RECEIVED' | 'IN_REVIEW' | 'COMPLIANCE_IN_REVIEW' | 'ACCOUNT_SETUP_IN_PROGRESS' | 'COMPLETED' | 'ACTION_REQUIRED' | 'APPROVED' | 'REJECTED' | 'PENDING_KYB' required

Status of the pre-onboarding registration

subStatus'AWAITING_EVALUATION' | 'COMPLIANCE_SCREENING' | 'RISK_ANALYSIS' | 'MISSING_DOCUMENTS' | 'MANUAL_REVIEW' | 'NO_OBSERVATIONS' | 'COMPLIANCE_RISK' | 'INVALID_DOCUMENT_TYPE' | 'INVALID_DOCUMENT_FORMAT' | 'COUNTRY_REQUIRES_KYB' | 'DECLARATION_NOT_ACCEPTED' | 'MERCHANT_ALREADY_EXISTS' | 'HIGH_RISK_COUNTRY' | 'REGISTERING_ACCOUNT' | 'APPLICANT_PENDING_COMPANY_PENDING' | 'APPLICANT_APPROVED_COMPANY_PENDING' | 'APPLICANT_APPROVED_COMPANY_APPROVED' | 'APPLICANT_APPROVED_COMPANY_REJECTED' | 'APPLICANT_REJECTED_COMPANY_PENDING' | 'APPLICANT_REJECTED_COMPANY_APPROVED' | 'APPLICANT_REJECTED_COMPANY_REJECTED' | 'APPLICANT_PENDING_COMPANY_APPROVED' | 'APPLICANT_PENDING_COMPANY_REJECTED' | 'COMPLIANCE_CHECK_ERROR' | 'SETUP_PENDING' | 'CREATING_ORGANIZATION' | 'CREATING_MERCHANT' | 'ASSIGNING_FEATURES' | 'ASSIGNING_FEES' | 'ASSIGNING_USER_ROLES' | 'ONBOARDING_COMPLETED'

Sub-status of the pre-onboarding registration

updatedAtstring required

Last update timestamp (ISO 8601)

organizationIdstring

Organization ID (present when org+merchant have been created for greylist/CT-flagged path)

merchantIdstring

Merchant ID (present when org+merchant have been created for greylist/CT-flagged path). Use this to call POST /organizations/{orgId}/merchants/{mrcId}/onboarding/kyb.

Example response

{
  "id": "onbreg_8f32c1d4-1b1c-4e9c-9a77-cc912a1c5a01",
  "status": "RECEIVED",
  "subStatus": "AWAITING_EVALUATION",
  "updatedAt": "2026-01-20T14:35:00Z"
}

Changes

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