Skip to main content
GET
Retrieve a Fraud Check
Retrieve a completed check using the same application’s credentials. The response is the stored execution result; retrieval does not rerun checks or incur another charge. Current sharing access applies to global network evidence: after access is revoked, shared aggregates and their derived risk evidence are hidden. The historical recommendation is preserved. An unknown, unfinished, or deleted check returns 404. A check belonging to another application also returns 404.

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.

Path Parameters

check_id
string<uuid>
required

Response

check_id
string<uuid>
required
client_reference
string | null
required
processing_status
enum<string>
required
  • pending - Pending
  • running - Running
  • completed - Completed
  • failed - Failed
Available options:
pending,
running,
completed,
failed
profile_id
string
required
profile_version
string
required
created_at
string<date-time>
required
completed_at
string<date-time> | null
required
inputs
object[]
required
modules
object[]
required
attribute_evidence
object[]
required
compound_evidence
object[]
required
risk
object[]
required
network
object
required
recommendation
enum<string>
required
  • approve - Approve
  • review - Review
  • reject - Reject
Available options:
approve,
review,
reject
next_action
enum<string>
required
  • none - None
  • manual_review - Manual Review
  • step_up - Step Up
  • resubmit_capture - Resubmit Capture
Available options:
none,
manual_review,
step_up,
resubmit_capture
decision_reasons
string[]
required
coverage
object
required
usage
object[]
required
request_id
string<uuid>

Native verification session created for this check.

enrichment
object
identity_relationship
object | null
vendor_data
string | null
metadata
unknown