Risk.Risk Insights

Create Risk Insights

Creates a request and returns the risk insights report id of an end-user as a JSON response.

post/risk/v1/risk-insights

Request body

accountIdsstring[]

Optional list of account IDs. If not empty, only specified accounts will be used in a report.

externalReferencestring

Optional reference given by the customer to add information, such as UID, to the generated report. (Validation: allowed lowercase and uppercase letters, numbers and dashes. Max 50 characters in length).

Example request

{
  "externalReference": "ext-abc-123"
}

Response

A successful response.

idstring required

The identifier of the risk insights report.

Example response

{
  "id": "61261abc769e42eebaae018bf34f1664"
}

Changes

No recorded changes to this endpoint across all 13 revisions of this API.