Order

An Order represents a completed ID verification transaction. Orders are automatically created when users finish the verification flow initiated by an invite, capturing comprehensive verification results, submitted documents, performed checks, and final outcomes.

Order Lifecycle

Orders are automatically created upon verification completion and include:

User information (name, email, address)
Submitted identity documents
Verification checks performed (ID verification, liveness detection, background checks)
Final verification outcome and risk assessment

Order Statuses

Value	Meaning
`PENDING`	Order created, awaiting processing or review
`IN_PROGRESS`	Verification is actively being processed
`IN_DISPUTE`	Results are under review or dispute
`INCOMPLETE`	Verification was not completed
`COMPLETE`	Order has been reviewed - either by automation or a human processor

Order Scores

The order score provides a standardized assessment of the verification outcome:

Value	Meaning
`ID_VERIFIED`	Identity document successfully verified
`ID_NOT_VERIFIED`	Identity document could not be verified
`NO_ALERTS`	No alerts found during verification
`ALERTS_FOUND`	Alerts were detected during verification
`PENDING`	Awaiting processing
`REVIEW_REQUIRED`	Additional review needed
`CLIENT_REVIEW`	Manual review required by client
`REVIEW_PASS`	Order passed the review process
`SCREENING_ALERT`	Screening detected potential issues
`SCREENING_NO_ALERT`	Screening completed without alerts
`SCREENING_PENDING`	Screening results are pending
`ON_HOLD`	CRA is internally checking the document - an intermediate state, not final
`PRE_ADVERSE`	Pre-adverse action indicated
`ADVERSE_ACTION`	Adverse action required based on results
`WITHDRAWN`	User has withdrawn from the verification

Order Alert

A simple binary signal that indicates whether any alerts were found on the order.

Value	Meaning
`NULL`	Order is not yet `COMPLETE` - alert has not been set
`NO_ALERTS_FOUND`	No alerts were detected
`ALERTS_FOUND`	One or more alerts were detected

Custom Scores

Assign custom risk scores or decisioning outcomes based on your internal rules and criteria. Custom scores allow you to evaluate orders using additional data points beyond standard verification results, enabling tailored risk assessment aligned with your business requirements.

Metadata

Orders inherit metadata from their originating invite and support additional key-value pairs for tracking and reconciliation. Metadata is:

Automatically copied from the invite
Included in all webhook payloads
Accessible via API when retrieving order details
Preserved throughout the order lifecycle

Common use cases include storing transaction IDs, internal user references, or application-specific context.

For detailed information about Metadata, see the Attaching Custom Data to Orders documentation.

Webhooks

Configure webhook notifications during invite creation to receive real-time order updates at your postback URL.

Supported Events

ORDER_STATUS_CHANGE - Triggered when order status changes
ORDER_SCORE_CHANGE - Triggered when order score updates
ORDER_CUSTOM_SCORE_CHANGE - Triggered when custom score is modified
ORDER_DISPUTE_RESOLVED - Triggered when dispute is resolved

For detailed information about webhook payloads and security, see the Webhooks documentation.

Retrieving Orders

Get Order Details

Retrieve comprehensive information about a specific order using the Get Order Details endpoint. Response includes user details, documents, verification checks, outcomes, and metadata.

List Orders

Retrieve a list of orders using the List Orders endpoint.

Query orders with filtering options:

Filter by package ID
Filter by order status