---
title: "Get onboarding readiness report for a merchant across all providers"
method: GET
path: "/api/v1/merchants/{merchantId}/onboarding"
tags: ["Onboarding"]
---

# Get onboarding readiness report for a merchant across all providers

`GET /api/v1/merchants/{merchantId}/onboarding`

## Request

- Base URL: `https://core.quidkey.com`
- URL: `https://core.quidkey.com/api/v1/merchants/{merchantId}/onboarding`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/banqzinc/apis/quidkey-api/docs/api/v1/merchants/:merchantId/onboarding/get.ts> (a function with typed inputs; its response is checked against the schema)

Get onboarding readiness report for a merchant across all providers

## Path parameters

- `merchantId` string, uuid, required: The unique identifier of the merchant

## Response `200`

Success

- OnboardingReadinessResponse: Response containing the onboarding readiness report
  - `success` boolean, required: Indicates if the request was successful
  - `data` object, required: Onboarding readiness report for all providers
    - `merchant_id` string, uuid, required: The merchant ID
    - `providers` object[], required
      - `provider` string, required: Provider identifier
      - `mode` union, required: Provider operating mode
        - 'sandbox'
        - 'live'
      - `status` union, required: Overall readiness status for this provider
        - 'not_applicable'
        - 'not_ready'
        - 'ready'
        - 'enrolling'
        - 'onboarded'
      - `requirements` object[], required
        - `code` string, required: Requirement identifier
        - `label` string, required: Human-readable label
        - `met` boolean, required: Whether the requirement is met
        - `blocker` string: Reason the requirement is not met
        - `problems` object[]: Specific field-level problems
          - `field` string, required: The field that has the problem
          - `message` string, required: Description of the problem
          - `value` unknown
      - `depends_on` object[], required
        - `provider` string, required: Provider identifier
        - `satisfied` boolean, required: Whether the dependency is satisfied
      - `can_enroll` boolean, required: Whether the merchant can enroll with this provider right now

## Other responses

- `401`: Unauthorized
- `404`: Not Found

## Changes

- **2026-06-17** `b372e7d5563d`: 1 info
  - endpoint added
- **2025-11-02** `919eb7a392aa`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/banqzinc/apis/quidkey-api/changes/api/v1/merchants/:merchantId/onboarding/get.md)

---

[API](https://skmtc.dev/banqzinc/apis/quidkey-api.md) - [All operations](https://skmtc.dev/banqzinc/apis/quidkey-api/llms.txt) - [OpenAPI document](https://skmtc.dev/banqzinc/apis/quidkey-api/revisions/f86d2bdbcb08?raw)