> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cleo-pay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get business status

> GET /v1/business reports the setup stage, whether payments are locked, the default rail, and whether each rail can send and receive. It works with any valid key, even before verification.

```
GET /v1/business
```

**Scope:** any valid key

This is the one call that answers while the business has not finished identity verification. Use it to tell your user what is left to do before they can pay or get paid. The MCP tool `get_business_status` returns the same.

```bash theme={null}
curl https://api.stg.cleo-pay.com/v1/business \
  --header "Authorization: Bearer $CLEO_API_KEY"
```

## Response

```json theme={null}
{
  "id": "5e6a1c2d-7b8e-4f90-a1b2-c3d4e5f6a7b8",
  "setupStage": "READY",
  "paymentsLocked": false,
  "paymentsLockReason": null,
  "bookingUrl": null,
  "defaultRail": "CLEO_PAY",
  "rails": [
    {
      "rail": "DWOLLA",
      "isDefault": false,
      "canSend": true,
      "sendBlockedReason": null,
      "canReceive": true,
      "receiveBlockedReason": null
    },
    {
      "rail": "CLEO_PAY",
      "isDefault": true,
      "canSend": true,
      "sendBlockedReason": null,
      "canReceive": true,
      "receiveBlockedReason": null
    }
  ],
  "dashboardUrl": "https://stg.cleo-pay.com/dash/business"
}
```

<ResponseField name="setupStage" type="string | null">
  `NOT_SUBMITTED`, `VERIFYING`, `ACTION_REQUIRED`, `AWAITING_CALL`, `SUSPENDED`, `LOCKED` or `READY`. `null` for a receive-only business.
</ResponseField>

<ResponseField name="paymentsLocked" type="boolean">True while Cleo has turned payments off for the business.</ResponseField>
<ResponseField name="paymentsLockReason" type="string | null">`awaiting_call`, `suspended` or `under_review`.</ResponseField>
<ResponseField name="bookingUrl" type="string | null">Where the business books the call that turns payments on. Set only while locked.</ResponseField>

<ResponseField name="defaultRail" type="string">
  `DWOLLA` or `CLEO_PAY`. Used only when a payment names no rail or source. Both rails stay usable.
</ResponseField>

<ResponseField name="rails" type="array">
  Every rail, default or not: `rail`, `isDefault`, `canSend`, `sendBlockedReason`, `canReceive`, `receiveBlockedReason`.
</ResponseField>

<ResponseField name="dashboardUrl" type="string">The business's Cleo dashboard.</ResponseField>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.