Verify a key

GET

/ping

curl --request GET \
  --url https://api.govza.app/v1/partner/ping \
  --header 'Authorization: Bearer <token>'

Confirms the key works and reports which account it acts as.

Authorizations

• apiKey

Responses

200

The key is valid.

Media typeapplication/json

object

success

boolean

data

object

ok

boolean

account

object

id

string

email

string

nullable

scopes

The current partner API has one scope, orders:write. It grants access to the full partner API, including reading orders. A separate read-only scope is not currently available.

Array<string>

rate_limit_per_minute

integer

nullable

Example^generated

{
  "success": true,
  "data": {
    "ok": true,
    "account": {
      "id": "example",
      "email": "example"
    },
    "scopes": [
      "example"
    ],
    "rate_limit_per_minute": 1
  }
}

401

The key is missing, malformed, revoked, or its account can no longer create orders.

Media typeapplication/json

object

success

boolean

error

object

id

string

code

string

message

string

details

string

Example

{
  "success": false
}