PropperDocs

Verify a credential

.md

Confirm a key works and see which firm, environment and scopes it resolves to.

GET/v1/ping

The first call to make when wiring up an integration. It needs no scope on purpose: a key that is not allowed to do anything yet should still be able to prove it is valid.

Request

curl https://api.proppertrading.com/v1/ping \
  -H "Authorization: Bearer sk_live_a1b2c3d4_9f83c2e15b7a4d6e8091c3f5a7b9d1e2"

Response

{
    "data": {
        "ok": true,
        "environment": "live",
        "api_key": "a1b2c3d4",
        "scopes": ["affiliates:write"],
        "tenant": { "name": "Acme Funded", "slug": "acme" },
        "time": "2026-08-03T12:00:00+00:00"
    },
    "meta": { "request_id": "req_01kz4bkr1aj1gv63d8fv3133ey" }
}
FieldDescription
environmentlive or test
api_keyThe key id, safe to log
scopesExactly what this key may do
tenantThe firm this key acts for

Check scopes here first

A scope problem shows up as a 403 halfway through an integration. This endpoint lets you see it in the first minute instead.