---
title: "Get merchant-facing go-live status with steps and progress"
method: GET
path: "/api/v1/merchants/{merchantId}/go-live"
tags: ["Go Live"]
---

# Get merchant-facing go-live status with steps and progress

`GET /api/v1/merchants/{merchantId}/go-live`

Get merchant-facing go-live status with steps and progress

## Path parameters

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

## Response `200`

Success

- GoLiveResponse — Response containing the go-live status report
  - `success` boolean, required — Indicates if the request was successful
  - `data` object, required — Merchant-facing go-live status report
    - `status` union, required — Overall go-live status for the merchant
      - 'in_progress'
      - 'awaiting_verification'
      - 'live'
    - `steps` object[], required — Ordered list of go-live steps with their statuses
      - `key` string, required — Step identifier
      - `label` string, required — Human-readable step label
      - `status` union, required — Status of a go-live step
        - 'not_started'
        - 'incomplete'
        - 'complete'
        - 'awaiting_verification'
        - 'action_needed'
      - `hint` string — Guidance text shown when step is not complete
    - `progress` object, required
      - `completed` integer, required — Number of completed steps
      - `total` integer, required — Total number of steps
      - `percentage` integer, required — Weighted progress percentage (0-100). Pending steps get partial credit.
    - `celebration_pending` boolean, required — True when merchant just went live and celebration has not been shown yet

## Other responses

- `401` — Unauthorized
- `404` — Not Found

---

[API](https://skmtc.net/banqzinc/apis/quidkey-api.md) · [All operations](https://skmtc.net/banqzinc/apis/quidkey-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/banqzinc/quidkey-api/versions/f86d2bdbcb08/schema)