Sign in
Compliance Screening

List compliance screenings

Changed on

Returns a paginated list of compliance screenings scoped to the authenticated tenant.

Supports Flop pagination and filtering:

  • page - Page number (1-indexed, default: 1)
  • page_size - Items per page (default: 20, max: 100)
  • order_by - Field to sort by
  • order_directions - Sort direction (asc or desc)
get/api/compliance-screenings

Request

  • Base URL: http://localhost:4100
  • URL: http://localhost:4100/api/compliance-screenings
  • Auth: none required

Query parameters

pageinteger

Page number (1-indexed)

page_sizeinteger

Items per page (max: 100)

order_bystring

Field to sort by

order_directionsstring

Sort direction (asc or desc)

Response

Compliance screening list

Example response

{
  "data": [
    {
      "aml_control_count": 0,
      "aml_high_risk_country": "",
      "screening_type": "sanctions",
      "compliance_screening_number": "",
      "sanctions_screening_date": "2020-04-20T16:20:00Z",
      "scope": "account_holder",
      "match_count": 0,
      "false_positive_qualifier": "none",
      "screening_status": "pending",
      "manual_review_required": false,
      "aml_control_flag": false,
      "screening_score": 0,
      "screened_at": "2020-04-20T16:20:00Z",
      "sanctions_screening_status": "cleared",
      "legal_entity_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
      "reviewed_by_user_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
      "screening_rules": "",
      "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
      "screened_entity_type": "individual",
      "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
      "payment_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
      "pep_indicator": false,
      "pep_list_name": "",
      "updated_at": "2020-04-20T16:20:00Z",
      "reviewed_at": "2020-04-20T16:20:00Z",
      "aml_geographic_risk_flag": false,
      "review_notes": "",
      "sanctions_matches": [
        null
      ],
      "aml_risk_score": 0,
      "screened_entity_name": "",
      "inserted_at": "2020-04-20T16:20:00Z",
      "blocklist_matches": [
        null
      ],
      "escalation_level": 0
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 50,
    "total_count": 125,
    "total_pages": 3
  }
}

Changes

  • e99ccd17df53Revision changes
    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      added the new beneficial_owner enum value to the // response property for the response status

    • warning

      added the new crypto_address enum value to the // response property for the response status

    • warning

      added the new payment_account enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status