Skip to main content
GET
/
v1
/
connect-platform
/
health
Connect platform health
curl --request GET \
  --url https://api.zeam.money/gw/v1/connect-platform/health \
  --header 'Authorization: Bearer <token>' \
  --header 'x-zeam-auth: <api-key>'
{}

Authorizations

​
Authorization
string
header
required

Bearer token issued by the gateway. Source the token from one of:

  • POST /v1/public/auth/verify-otp (OTP user)
  • POST /v1/public/auth-connect/sign-in (Connect app)
  • OAuth (end-user mobile/web)

Include as Authorization: Bearer <token>.

​
x-zeam-auth
string
header
required

Connect secret for the Connect route group. Partners must include their issued connect secret (x-zeam-auth: <connect-secret>) on all /v1/connect-* calls.

Response

Platform health.

The response is of type object.