Skip to main content
GET
curl

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Response

Current credit balance plus the organization's auto-refill configuration.

balance
string
required

Current pre-paid credit balance in USD, as a fixed-point decimal string. Decreases as verifications are billed and increases when a top-up settles.

auto_refill_enabled
boolean
required

When true, Didit will automatically charge the saved Stripe payment method to add credits once the balance crosses auto_refill_threshold. Configured from Console → Billing.

auto_refill_amount
string | null

USD amount that will be charged on each auto-refill. null when auto-refill is disabled or unset.

auto_refill_threshold
string | null

Trigger threshold in USD. Auto-refill fires when balance falls below this value. null when auto-refill is disabled or unset.