Onboarding

Get onboarding status for authenticated user

Returns all onboarding evaluations and their setup status for the currently authenticated user. Optionally filter by evaluation status or setup status.

get/api/v1/onboarding/me

Request

  • Base URL: https://api-sandbox.koywe.com
  • URL: https://api-sandbox.koywe.com/api/v1/onboarding/me
  • Auth: HTTP bearer

Query parameters

evaluationStatus'RECEIVED' | 'IN_REVIEW' | 'COMPLIANCE_IN_REVIEW' | 'ACCOUNT_SETUP_IN_PROGRESS' | 'COMPLETED' | 'ACTION_REQUIRED' | 'APPROVED' | 'REJECTED' | 'PENDING_KYB'

Filter by evaluation status

setupStatus'PENDING' | 'RUNNING' | 'FAILED' | 'COMPLETED'

Filter by setup status

Response

Onboarding status retrieved successfully

Example response

{
  "evaluation": [
    {
      "id": "onbreg_6a37fda4-03ed-4954-9d64-87fb83242c93",
      "status": "APPROVED",
      "subStatus": "NO_OBSERVATIONS",
      "updatedAt": "2026-01-26T16:02:00Z",
      "setup": [
        {
          "id": "setreg_a1f3c8b2-7d44-4f8b-9e12-91c1b8a21111",
          "organizationId": "org_1234567890",
          "merchantId": "mrc_1234567890",
          "status": "PENDING"
        }
      ]
    }
  ]
}

Changes

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