v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB

Exports

Create a new export

Create a new export by selecting an export type and a start and end date. The available export names are CUSTOMER_SCREENING, CUSTOMER, SCREENING_AND_MONITORING_CASES, PROFILES, PAYMENT_SCREENING_CASES, TRANSACTION_MONITORING_CASES_AND_ALERTS, TRANSACTIONS.

You need the "View and download insights" permission to use this endpoint.

post/v2/exports

Request body

end_datestring date-time nullable

Export data end date

export_namestring required

Export name, created by customer

export_type_keystring required

Export type key

start_datestring date-time nullable

Export data start date

Example request

{
  "end_date": "2023-11-05T21:00:00.000Z",
  "export_name": "profiles-2023-q1-exports",
  "export_type_key": "CUSTOMER_SCREENING",
  "start_date": "2023-11-01T21:00:00.000Z"
}

Response

Export successfully created

created_atstring date-time required

Export creation time

export_namestring required

Export name, created by customer

export_type_keystring required

Export type key

identifierstring uuid required

Export type id

statusstring required

Export status

window_end_timestring date-time nullable

Export data end date

window_start_timestring date-time nullable

Export data start date

Example response

{
  "created_at": "2023-12-11T09:30:03.975Z",
  "export_name": "profiles-2023-q1-exports",
  "export_type_key": "CUSTOMER_SCREENING",
  "identifier": "550e8400-e29b-41d4-a716-446655440000",
  "status": "PENDING",
  "window_end_time": "2023-04-01T00:00:00.000Z",
  "window_start_time": "2023-01-01T00:00:00.000Z"
}