---
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`

## Request

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

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

## 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/go-live/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)