🔒
Requires read_order access scope. More access scope

The Order Risk Detail API retrieves the details of a specific risk associated with an order, providing insights into flagged risks for better decision-making.

This API is especially useful for:

Reviewing specific risks flagged for an order.
Enhancing fraud detection and order management processes.
Providing detailed explanations for flagged risks.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Path Parameters

Parameter	Type	Required	Description	Example
`order_id`	string	Yes	The unique ID of the order.	`633130-00000015`
`id`	string	Yes	The unique ID of the risk.	`372997190468224746`

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Successful Response

Parameter	Type	Example	Description
`code`	string	`"success"`	Status code of the API response
`message`	string	`"Order retrieved successfully"`	Descriptive message about the response
`data`	object

Risk Object Structure

Field	Type	Description	Example
`id`	string	The unique ID of the created risk.	`372997190468224746`
`order_id`	string	The unique ID of the order associated with the risk.	`633130-00000015`
`level`	string	Risk level for the order. Possible values: `low`, `medium`, `high`.	`low`
`details`	array of strings	List of reasons or details for the risk.	`["wrong order price"]`
`properties`	array of objects	Custom key-value pairs for additional risk information	`"properties": {"risk_source": "manual_review", "reviewer_id": "user_123","is_high_priority": true, "verification_steps": ["phone_call", "id_check"] },`
`created_at`	string	Timestamp when the risk was created (ISO 8601 format).	`2024-04-25T06:37:40Z`
`updated_at`	string	Timestamp when the risk was last updated (ISO 8601 format).	`2024-04-25T06:37:40Z`

Error Response

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string		Error message