Create a customer evaluation

Creates a new CustomerEvaluation object.

Returns

Returns a CustomerEvaluation object if creation succeeds.

Parameters

• evaluation_context (array of objects, required) Array of context entries for the evaluation.

  • evaluation_context.type (enum, required) The type of context entry. Possible enum values:

    • client_details
    • customer_details

  • evaluation_context.client_details (object, optional) Client details context.

    • evaluation_context.client_details.radar_session (string, required) ID for the Radar Session associated with the customer evaluation.

  • evaluation_context.customer_details (object, optional) Customer details context.

    • evaluation_context.customer_details.customer (string, optional) The ID of an existing Customer.

    • evaluation_context.customer_details.customer_data (object, optional) Customer data

      • evaluation_context.customer_details.customer_data.email (string, optional) Customer email

      • evaluation_context.customer_details.customer_data.name (string, optional) Customer name

      • evaluation_context.customer_details.customer_data.phone (string, optional) Customer phone

• event_type (enum, required) The type of evaluation event. Possible enum values:

  • login
  • registration

Registration from customer ID

Registration from customer ID

curl https://api.stripe.com/v1/radar/customer_evaluations \
  -u "<<YOUR_SECRET_KEY>>" \
  -d event_type=registration \
  -d "evaluation_context[0][type]=client_details" \
  -d "evaluation_context[0][client_details][radar_session]=rse_123456789" \
  -d "evaluation_context[1][type]=customer_details" \
  -d "evaluation_context[1][customer_details][customer]=cus_123456789"

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
    }
  }
}

Login from customer ID

Login from customer ID

curl https://api.stripe.com/v1/radar/customer_evaluations \
  -u "<<YOUR_SECRET_KEY>>" \
  -d event_type=login \
  -d "evaluation_context[0][type]=client_details" \
  -d "evaluation_context[0][client_details][radar_session]=rse_123456789" \
  -d "evaluation_context[1][type]=customer_details" \
  -d "evaluation_context[1][customer_details][customer]=cus_123456789"

Response

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