Dow Jones Assessment Export API

openapi: 3.2.0
info:
  title: Advanced Screening and Monitoring Assessment Export API
  description: 'Dow Jones


    ### Rate limits


    Most endpoints are subject to a general rate limit of 10,000 requests per user per 15 minutes.


    Some endpoints are also subject to a global concurrent request limit of 5 simultaneous requests per customer.'
  version: '3'
  license: {}
  contact: {}
servers:
- url: API_INSTANCE
security:
- basicAuth: []
- jwt: []
- clientCert: []
tags:
- name: Assessment Export
  description: The Assessment Export API allows clients to export details of assessments, assessment evidence and assessment activities.
paths:
  /assessment/export/jsonl:
    post:
      summary: Fetch assessments in JSON-L format
      description: 'Request to export assessments in the system as JSON-L format.

        ### Rate Limits


        This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.


        <!-- operational-characteristics:start -->


        ### Operational characteristics


        Values below are measured from production traffic. Only collected values are shown.


        **Latency distribution**


        Latency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).


        | Metric | Value |

        | --- | --- |

        | Median | 66 ms |

        | 90th percentile | 561 ms |

        | 95th percentile | 755 ms |

        | 98th percentile | 1.1 s |

        | 99th percentile | 1.3 s |

        <!-- operational-characteristics:end -->


        Each assessment includes `riskTags` and `tags` (including `userTag-{pillLabel}-active|inactive`

        for custom categories when enabled). Enriched `results` entries expose the same fields per linked alert.


        Please note, at scale some queries to this endpoint may slowdown. Please test your particular access pattern at the scale you are running at.

        '
      operationId: assessmentExport
      tags:
      - Assessment Export
      x-operational-characteristics:
        description: 'Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).

          '
        latencyDistribution:
          median: 65.94
          p90: 560.44
          p95: 754.4
          p98: 1066.89
          p99: 1300.49
          sampleSize: 610091
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                assessmentFilter:
                  type: object
                  description: The collection of filters
                  anyOf:
                  - properties:
                      operator:
                        type: string
                        description: high level boolean operator (default "AND")
                        enum:
                        - AND
                        - OR
                      filters:
                        type: array
                        items:
                          oneOf:
                          - type: object
                            allOf:
                            - not:
                                required:
                                - createdBy
                                - createdByExternalIds
                            properties:
                              status:
                                type: array
                                items:
                                  type: integer
                                  example: 1
                                description: The status of the assessment
                              precision:
                                type: array
                                items:
                                  type: string
                                  example: torch_normal
                                description: 'The precision setting of the search to be applied as part of the assessment. Deprecated as precision is now defined in the policy.

                                  '
                                deprecated: true
                              created:
                                type: object
                                properties:
                                  gte:
                                    type: number
                                    example: 1590973346512
                                  lte:
                                    type: number
                                    example: 1590989346512
                                  gt:
                                    type: number
                                    example: 1590989346512
                                  lt:
                                    type: number
                                    example: 1590989346512
                                description: Timestamp range for when the assessment was created
                              updated:
                                description: Timestamp range for when the assessment was last updated
                                type: object
                                properties:
                                  gte:
                                    type: number
                                    example: 1590973346512
                                  lte:
                                    type: number
                                    example: 1590989346512
                                  gt:
                                    type: number
                                    example: 1590989346512
                                  lt:
                                    type: number
                                    example: 1590989346512
                              closureDate:
                                description: Timestamp range for when the assessment was closed
                                type: object
                                properties:
                                  gte:
                                    type: number
                                    example: 1590973346512
                                  lte:
                                    type: number
                                    example: 1590989346512
                                  gt:
                                    type: number
                                    example: 1590989346512
                                  lt:
                                    type: number
                                    example: 1590989346512
                              id:
                                description: Array of assessments IDs
                                type: array
                                items:
                                  type: string
                                example:
                                - AS-3
                                - AS-100
                                - AS-201
                              createdBy:
                                description: Internal IDs of users who created the assessments. Cannot be used in conjunction with createdByExternalIds.
                                type: array
                                items:
                                  type: integer
                                  example: 990
                              createdByExternalIds:
                                description: External IDs of users who created the assessments. Cannot be used in conjunction with createdBy.
                                type: array
                                items:
                                  type: string
                                  example: john.smith@ripjar.com
                              policyId:
                                description: ID of the policy associated with this assessment
                                type: array
                                items:
                                  type: integer
                                  example: 10002
                              previousAssignees:
                                type: array
                                items:
                                  type: object
                                  allOf:
                                  - not:
                                      required:
                                      - includes
                                      - includesExternalIds
                                  - not:
                                      required:
                                      - excludes
                                      - excludesExternalIds
                                  properties:
                                    includes:
                                      description: array of internal user IDs. Cannot be used in conjunction with includesExternalIds.
                                      type: array
                                      items:
                                        type: number
                                        example: 990
                                    includesExternalIds:
                                      description: array of external user IDs. Cannot be used in conjunction with includes.
                                      type: array
                                      items:
                                        type: string
                                        example: john.smith@ripjar.com
                                    excludes:
                                      description: array of internal user IDs. Cannot be used in conjunction with excludesExternalIds.
                                      type: array
                                      items:
                                        type: number
                                        example: 990
                                    excludesExternalIds:
                                      description: array of external user IDs. Cannot be used in conjunction with excludes.
                                      type: array
                                      items:
                                        type: string
                                        example: john.smith@ripjar.com
                          - type: object
                            description: recursive filter
                            properties:
                              operator:
                                type: string
                                description: high level boolean operator (default "AND")
                                enum:
                                - AND
                                - OR
                              filters:
                                description: recursive filter
                  - type: object
                    properties:
                      skip:
                        type: integer
                        default: 0
                        description: The number of records to skip.
                      limit:
                        type: integer
                        default: 100
                        description: The number of records to return. Setting this to zero (0) returns all records.
                      sort:
                        type: string
                        description: Field to sort by and sort order
                        enum:
                        - created:1
                        - created:-1
                        - updated:1
                        - updated:-1
                        - closureDate:1
                        - closureDate:-1
                enrich:
                  type: object
                  description: Instructions to enrich specific parts to the results
                  properties:
                    results:
                      type: boolean
                      description: enrich the results property (the objects produced as a result of the assessment) with extra fields
            example:
              assessmentFilter:
                filters:
                - status:
                  - 1
                  created:
                    gte: 0
                  updated:
                    lte: 1590989346512
                  policyId:
                  - 10002
                - operator: OR
                  filters:
                  - id:
                    - AS-3
                    - AS-100
                    - AS-201
                  - createdBy:
                    - 990
                operator: AND
                skip: 0
                limit: 0
                sort: created:1
              enrich:
                results: true
      responses:
        '200':
          description: Assessments retrieved
          content:
            application/jsonld:
              schema:
                oneOf:
                - description: Line-delimited JSON assessment objects
                  type: object
                  properties:
                    createdBy:
                      type: number
                      example: 10002
                      description: ID of the user who created the assessment
                    clientKey:
                      type: string
                      example: lowercasekey
                      description: The system client key that owns the assessment
                    policyId:
                      type: number
                      example: 10002
                      description: Represents the policy for generating the assessment
                    assessmentRange:
                      type: object
                      description: The time frame in which the assessment has been conducted
                      properties:
                        gte:
                          type: number
                          example: 1588078084933
                          description: The lower bound of the range (greater than or equal to)
                        lte:
                          type: number
                          example: 1590670084934
                          description: The upper bound of the range (less than or equal to)
                    label:
                      type: string
                      example: john doe
                      description: The name of the assessed entity
                    targets:
                      type: array
                      description: 'Contains information regarding the clients (EOIs) that matched the assessed entity

                        '
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 2f4aab0d-deee-4460-a3df-82e0cf817fe9
                          eoiId:
                            type: string
                            example: assessment:2f4aab0d-deee-4460-a3df-82e0cf817fe9
                          _revision:
                            type: number
                            example: 1251
                    results:
                      type: array
                      description: The objects produced as a result of the assessment
                      items:
                        type: object
                        properties:
                          id:
                            type: number
                          status:
                            type: number
                          assignedUsers:
                            example:
                            - username: John Smith
                              email: john.smith@ripjar.com
                              externalId: john.smith@ripjar.com
                              mobile: 01234567890
                              roles:
                              - ROLE_1
                              cn: john.smith@ripjar.com
                              clientKey: lowercasekey
                              customerExcludedApps:
                              - app
                              security: {}
                              lastLogin: 1596188918065
                              username_lowercase: john smith
                              lineNumber: 4
                              lastModified: 1595437138430
                              id: 10003
                              dateCreated: 1595437138459
                            oneOf:
                            - type: array
                              description: IDs of users assigned to the result, returned when results enrichment is disabled
                              items:
                                type: number
                              example:
                              - 1
                            - type: array
                              description: Objects representing users assigned to the result, returned when results enrichment is enabled
                              items:
                                type: object
                                properties:
                                  username:
                                    type: string
                                    example: John Smith
                                  email:
                                    type: string
                                    example: john.smith@ripjar.com
                                  externalId:
                                    type: string
                                    example: john.smith@ripjar.com
                                  mobile:
                                    type: string
                                    example: 01234567890
                                  roles:
                                    type: array
                                    items:
                                      type: string
                                      example: ADMINISTRATOR
                                  cn:
                                    type: string
                                    example: john.smith@ripjar.com
                                  clientKey:
                                    type: string
                                    example: lowercasekey
                                  customerExcludedApps:
                                    type: array
                                    nullable: true
                                    items:
                                      type: string
                                      example: app
                                  security:
                                    type: object
                                  lastLogin:
                                    type: number
                                    example: 1596188918065
                                  username_lowercase:
                                    type: string
                                    example: john smith
                                  lineNumber:
                                    type: number
                                    example: 4
                                  lastModified:
                                    type: number
                                    example: 1595437138430
                                  id:
                                    type: number
                                    example: 1
                                  dateCreated:
                                    type: number
                                    example: 1595437138459
                              components:
                                schemas:
                                  AssignedUserEnriched:
                                    type: object
                                    properties:
                                      username:
                                        type: string
                                        example: John Smith
                                      email:
                                        type: string
                                        example: john.smith@ripjar.com
                                      externalId:
                                        type: string
                                        example: john.smith@ripjar.com
                                      mobile:
                                        type: string
                                        example: 01234567890
                                      roles:
                                        type: array
                                        items:
                                          type: string
                                          example: ADMINISTRATOR
                                      cn:
                                        type: string
                                        example: john.smith@ripjar.com
                                      clientKey:
                                        type: string
                                        example: lowercasekey
                                      customerExcludedApps:
                                        type: array
                                        nullable: true
                                        items:
                                          type: string
                                          example: app
                                      security:
                                        type: object
                                      lastLogin:
                                        type: number
                                        example: 1596188918065
                                      username_lowercase:
                                        type: string
                                        example: john smith
                                      lineNumber:
                                        type: number
                                        example: 4
                                      lastModified:
                                        type: number
                                        example: 1595437138430
                                      id:
                                        type: number
                                        example: 1
                                      dateCreated:
                                        type: number
                                        example: 1595437138459
                          state:
                            type: number
                            description: (Only present if results enrichment is enabled) The state of the result
                          score:
                            type: number
                            description: (Only present if results enrichment is enabled) The score assigned to the result
                          time:
                            type: object
                            description: (Only present if results enrichment is enabled)
                            properties:
                              created:
                                description: The time the result was created in ms epoch
                                type: number
                              lastUpdated:
                                description: The time the result was last updated in ms epoch
                                type: number
                          tags:
                            description: '(Only present if results enrichment is enabled) Tags associated with the result, including `userTag-{pillLabel}-active|inactive` for custom categories when exported.

                              '
                            allOf:
                            - type: array
                              description: 'Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and—when custom categories apply—entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.

                                '
                              items:
                                type: string
                              example:
                              - policy-20037
                              - risk-Financial Crime
                              - userTag-Fin Crime-active
                          riskTags:
                            description: '(Only present if results enrichment is enabled) Risk tags for the result, including custom category stamps (`cc{id}` with optional `-active` / `-inactive` suffix).

                              '
                            allOf:
                            - type: array
                              description: 'Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).

                                '
                              items:
                                type: string
                              example:
                              - PEP-active
                              - cc42-active
                    created:
                      type: number
                      example: 1590670084934
                      description: Unix Epoch timestamp for when the assessment was created
                    updated:
                      type: number
                      example: 1590670087032
                      description: Unix Epoch timestamp for when the assessment was updated
                    precision:
                      type: string
                      example: torch_fuzzy
                      description: 'The matching strategy used to connect the input to other entities in the system

                        '
                    options:
                      type: object
                      example:
                        languages: []
                      description: The options used when the assessment was created
                    security:
                      type: object
                      description: Security settings attributed to the assessment
                    namespace:
                      type: string
                      example: torch
                      description: The system namespace
                    status:
                      type: number
                      example: 1
                      description: The assessment's status
                    id:
                      type: string
                      example: AS-132
                      description: The assessment's ID
                    tags:
                      type: array
                      description: 'Tags associated with the entity for export and integration. Includes policy identifiers, standard risk labels, and—when custom categories apply—entries of the form `userTag-{pillLabel}-active` or `userTag-{pillLabel}-inactive` derived from `cc*` stamps on `riskTags`. Existing tag entries are preserved in their original order; matching `userTag-*` entries are appended on export when custom categories are enabled. There is no separate `customCategories` response property.

                        '
                      items:
                        type: string
                      example:
                      - policy-20037
                      - risk-Financial Crime
                      - userTag-Fin Crime-active
                    riskTags:
                      type: array
                      description: 'Risk tags stamped on the entity. Standard watchlist tags use configured prefixes and optional `-active` or `-inactive` suffixes (e.g. `PEP-active`). Custom categories are stamped with the `cc` prefix followed by the category id, optionally suffixed with `-active` or `-inactive` (e.g. `cc42`, `cc42-active`). Custom category values remain on `riskTags`; JSONL and CSV exports also add human-readable `userTag-{pillLabel}-active|inactive` entries on `tags` (see ExportTags).

                        '
                      items:
                        type: string
                      example:
                      - PEP-active
                      - cc42-active
                    groupContext:
                      type: object
                      required:
                      - isPrimary
                      - groupId
                      properties:
                        isPrimary:
                          type: boolean
                          description: if this assessment is the primary one of the group
                          example: false
                        groupId:
                          type: string
                          description: id of the group
                          example: 03b9a256-9524-4ed8-9d23-84a213793b7b
                        relationship:
                          type: object
                          properties:
                            type:
                              type: string
                              description: type of relationship between assessed entity and the primary assessment
                              example: FRIEND
                - type: object
                  required:
                  - code
                  - message
                  properties:
                    code:
                      type: string
                      description: Error code that can be used when contacting support or looking up information
                    message:
                      type: string
                      description: Human-readable description of the error, which will usually indicate possible next steps if applicable
                    status:
                      type: number
                      description: HTTP Error code
        '400':
          description: Bad request
        '401':
          description: Unauthenticated request
        '403':
          description: The authenticated user cannot view assessments
        '500':
          description: An unexpected error occurred when fetching the assessments
          content:
            application/json:
              schema:
                type: object
                required:
                - code
                - message
                properties:
                  code:
                    type: string
                    description: Error code that can be used when contacting support or looking up information
                  message:
                    type: string
                    description: Human-readable description of the error, which will usually indicate possible next steps if applicable
                  status:
                    type: number
                    description: HTTP Error code
              examples:
                unexpectedError:
                  summary: Unexpected Error
                  value:
                    code: ERROR_GETTING_ASSESSMENT
                    message: An error occurred retrieving the assessments
  /assessment/evidence/export/jsonl:
    post:
      summary: Export evidence in JSON-L format
      description: 'Streaming filtered export of evidence in jsonl format. If the assessment is closed the matches enrichment will not be populated.

        ### Rate Limits


        This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes, and a global concurrent request limit of 5 simultaneous requests per customer.


        <!-- operational-characteristics:start -->


        ### Operational characteristics


        Values below are measured from production traffic. Only collected values are shown.


        **Latency distribution**


        Latency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).


        | Metric | Value |

        | --- | --- |

        | Median | 920 ms |

        | 90th percentile | 5.2 s |

        | 95th percentile | 1:08 (min) |

        | 98th percentile | 1:15 (min) |

        | 99th percentile | 1:18 (min) |

        <!-- operational-characteristics:end -->

# --- truncated at 32 KB (1775 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dow-jones/refs/heads/main/openapi/dow-jones-assessment-export-api-openapi.yml