Customer Evaluations

Customer Evaluation resource returned by the Radar Customer Evaluations API.

Was this section helpful? Yes No

Create a customer evaluation

POST / v1 / radar / customer_evaluations

Report an event on a customer evaluation

POST / v1 / radar / customer_evaluations /:id / report

The Customer Evaluation object

Attributes

• id string Unique identifier for the object.
• object string, value is "radar.customer_evaluation" String representing the object’s type. Objects of the same type share the same value.
• customer nullable string The ID of the Customer to associate with this CustomerEvaluation.
• event _ type enum The type of evaluation event. Possible enum values login A customer login event. registration A customer registration event.
• events nullable array of objects A list of events that have been reported on this customer evaluation.
• signals nullable object A hash of signal objects providing Radar’s evaluation of the customer.
• status nullable string The outcome status reported for this evaluation: allowed, restricted, or blocked.

More attributes

• created _ at timestamp
• livemode boolean

The Customer Evaluation object

{ "id": "cuseval_123456789", "object": "radar.customer_evaluation", "event_type": "registration", "livemode": true, "created_at": 1715769600, "customer": "cus_123456789", "events": null, "signals": { "multi_accounting": { "score": 50.1, "evaluated_at": 1715769600, "risk_level": null } }}

Create a customer evaluation

POST / v1 / radar / customer_evaluations

Creates a new CustomerEvaluation object.

Parameters

• evaluation _ context array of objects Required Array of context entries for the evaluation.
• event _ type enum Required The type of evaluation event. Possible enum values login registration

Returns

Returns a CustomerEvaluation object if creation succeeds.

cURL

Response

{ "id": "cuseval_123456789", "object": "radar.customer_evaluation", "event_type": "registration", "livemode": true, "created_at": 1715769600, "customer": "cus_123456789", "events": null, "signals": { "multi_accounting": { "score": 50.1, "evaluated_at": 1715769600, "risk_level": null } }}