Get business status

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.

curl https://api.stg.cleo-pay.com/v1/business \
  --header "Authorization: Bearer $CLEO_API_KEY"

Response

{
  "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"
}

string | null

NOT_SUBMITTED, VERIFYING, ACTION_REQUIRED, AWAITING_CALL, SUSPENDED, LOCKED or READY. null for a receive-only business.

boolean

True while Cleo has turned payments off for the business.

string | null

awaiting_call, suspended or under_review.

string | null

Where the business books the call that turns payments on. Set only while locked.

string

DWOLLA or CLEO_PAY. Used only when a payment names no rail or source. Both rails stay usable.

array

Every rail, default or not: rail, isDefault, canSend, sendBlockedReason, canReceive, receiveBlockedReason.

string

The business’s Cleo dashboard.

Business

Payables

Payments

Contacts

Invoices

Balance

Bank Accounts

Webhook Endpoints

Get business status

Response

​Response

Response