Account
Your own account. There is no way to read another account on this API. mode is the go-live entitlement on the account, which is separate from the sandbox or live mode a given key runs in. Requires the settings:read permission on the calling key.
Authorization
secretKey Secret API key, e.g. kyc_live_... (server-side) or kyc_test_... (sandbox).
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/merchant"{ "id": "string", "object": "merchant", "name": "string", "slug": "string", "status": "active", "mode": "sandbox", "tier": "standard", "created_at": "2019-08-24T14:15:22Z"}What the key in the Authorization header can actually do: which mode it runs in, which engine tier it is entitled to, and which permissions it carries. Use it to predict a 403 before you hit one. Requires the settings:read permission on the calling key.
Authorization
secretKey Secret API key, e.g. kyc_live_... (server-side) or kyc_test_... (sandbox).
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/entitlements"{ "object": "entitlements", "mode": "sandbox", "tier": "standard", "environment": "live", "permissions": [ "verification:create" ]}Counts of metered operations, grouped by operation type, for your account. Pass since to bound the window; without it the summary covers everything on record. Requires the analytics:read permission on the calling key, which is not part of the default permission set.
Authorization
secretKey Secret API key, e.g. kyc_live_... (server-side) or kyc_test_... (sandbox).
In: header
Query Parameters
RFC 3339 lower bound for the summary window.
date-timeResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/usage"{ "object": "usage_summary", "since": "2019-08-24T14:15:22Z", "total": 0, "billable": 0, "by_check_type": [ { "check_type": "liveness", "count": 0, "billable": 0 } ]}