Skip to main content
POST
Python
Send the same body you intend to use for Fraud Check. Planning creates no check or session, calls no enrichment supplier, reads no network history, and charges nothing. Each module separates available from will_run. availability_reason explains whether the supplied inputs can support it, while selection_reason explains why it is or is not selected. Keep unavailable switches visible and show their input requirements. networks_cross_org needs the Enterprise plan and your organization’s sharing mode set to global. Without them, or when Networks is not enabled for your organization, the plan reports it with available: false and availability_reason: "entitlement_required". A check that selects it skips it with the same reason. Sandbox applications are not gated by plan or sharing mode: with a supported identifier, the module runs and returns an empty sample result. estimated_price is a decimal string in the returned currency. A null price means unavailable or unpriced, not free. The top-level estimate totals selected runnable modules; can_afford also checks the applicable billing arrangement. Re-plan after changing identifiers, context, or selections. Execution rechecks eligibility and pricing, so a plan is not a reservation or a guarantee that an external source will answer.

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 wrong, revoked or expired; 403 means no key was sent, 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.

Headers

Idempotency-Key
string

Optional retry-safety key you choose for one operation, up to 255 characters (a UUID works). A request repeated with the same key, endpoint, query and body is answered with the first response, same status and same body, and runs and bills nothing a second time. The same key with another endpoint, query or body returns 409 idempotency_key_reused, and while the first request is still running, 409 idempotency_key_in_progress with Retry-After. A failed request (any 4xx or 5xx) is not stored, so you can send it again with the same key. Keys belong to your application, whether you call with an API key or an access token. See Retries and idempotency.

Required string length: 1 - 255

Body

subject
object
required
client_reference
string

Your own reference for this check. Doubles as the idempotency key: reusing it with the same body returns the original check without running or billing the modules again; reusing it with a different body returns 409.

Required string length: 1 - 255
profile
string
default:standard

Orchestration profile id. Defaults to the Didit standard profile.

Required string length: 1 - 64
profile_version
string

Pin a frozen profile version. Defaults to the current version of the profile.

Required string length: 1 - 32
context
object
checks
object
vendor_data
string
Maximum string length: 1000
metadata
any

Response

profile_id
string
required
profile_version
string
required
modules
object[]
required
estimated_price
string | null
required
currency
string | null
required
is_sandbox
boolean
required
can_afford
boolean
required
Last modified on November 1, 2026