Dow Jones Entity API

openapi: 3.2.0
info:
  title: Advanced Screening and Monitoring Entity 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: Entity
  description: The Entity API allows clients to retrieve details of and reconcile entities (i.e. clients, risk profiles and internal list entities) stored in the system.
paths:
  /entity/client-count:
    get:
      summary: Fetch the number of clients in the system
      description: 'Returns the total number of clients in the system including counts of active and inactive clients.

        ### 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.

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

          '
        latencyDistribution:
          median: 8
          p90: 12.8
          p95: 13.4
          p98: 13.76
          p99: 13.88
          sampleSize: 3
      parameters:
      - in: query
        name: ignoreSecurity
        required: false
        description: 'Whether or not to ignore security and either return the full count in LS or return the visible count for the authenticated user. If `false`, the counts represent the number of entities that are visible to the authenticated calling user based on the user''s security settings. If `true`, the counts returned are the totals for all entities in the system, ignoring the authenticated user''s security settings.

          '
        schema:
          type: boolean
      responses:
        '200':
          description: Counts retrieved successfully
          content:
            application/json:
              schema:
                type: object
                description: Counts of the number of client entities in the system. The counts will either be for the entities visible to the calling user, or all entities depending on the value of the `ignoreSecurity` flag in the request.
                properties:
                  count:
                    type: number
                    description: The number of client entities in the system.
                  active:
                    type: number
                    description: The number of counted entities with Active status.
                  inactive:
                    type: number
                    description: The number of counted entities with Inactive status.
        '401':
          description: Unauthenticated request
          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
        '403':
          description: Forbidden request
          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
        '500':
          description: An unexpected error occurred when fetching the client counts.
          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: '500'
                    message: An error occurred getting the clients counts.
  /entity/client-query:
    post:
      summary: Queries the clients in LS and streams response
      description: 'Returns clients filtered by the query specified in the request. For example, requesting all Active clients will return the list of active clients that the calling user has permission to see.

        Client records are streamed as line-delimited JSON records conforming to the schema.

        The records returned are restricted by the calling user''s security settings, so that the user will not see restricted information that is outside their own permissions.

        ### 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 | 5.5 s |

        | 90th percentile | 6.7 s |

        | 95th percentile | 7.3 s |

        | 98th percentile | 8.5 s |

        | 99th percentile | 9.4 s |

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


        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: entityClientQuery
      tags:
      - Entity
      x-operational-characteristics:
        description: 'Operational characteristics from production log analysis (generatedAt: 2026-06-16T10:56:29.271Z).

          '
        latencyDistribution:
          median: 5460.74
          p90: 6655.51
          p95: 7347.59
          p98: 8522.95
          p99: 9409.2
          sampleSize: 10962
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                queryFields:
                  type: object
                  description: 'Any field that a client can have can be filtered against. Below is a subset of common fields that will most likely be used for filtering.

                    '
                  properties:
                    name:
                      type: string
                      description: The full name of the individual
                    surname:
                      type: string
                      description: The family name of the individual
                    firstName:
                      type: string
                      description: The primary given name of the individual
                    middleName:
                      type: string
                      description: All other parts of the legal name not covered in first and surname fields
                    gender:
                      type: string
                      enum:
                      - MALE
                      - FEMALE
                      - OTHER
                    citizenshipCode:
                      description: 'A list of country codes reflecting known citizenships of the individual.

                        '
                      type: array
                      minLength: 1
                      items:
                        type: string
                        maxLength: 2
                        minLength: 2
                        description: 'An ISO-3166 alpha-2 country code digraph as defined here: <https://www.iso.org/iso-3166-country-codes.html>

                          '
                        enum:
                        - AD
                        - AE
                        - AF
                        - AG
                        - AI
                        - AL
                        - AM
                        - AO
                        - AQ
                        - AR
                        - AS
                        - AT
                        - AU
                        - AW
                        - AX
                        - AZ
                        - BA
                        - BB
                        - BD
                        - BE
                        - BF
                        - BG
                        - BH
                        - BI
                        - BJ
                        - BL
                        - BM
                        - BN
                        - BO
                        - BQ
                        - BR
                        - BS
                        - BT
                        - BV
                        - BW
                        - BY
                        - BZ
                        - CA
                        - CC
                        - CD
                        - CF
                        - CG
                        - CH
                        - CI
                        - CK
                        - CL
                        - CM
                        - CN
                        - CO
                        - CR
                        - CU
                        - CV
                        - CW
                        - CX
                        - CY
                        - CZ
                        - DE
                        - DJ
                        - DK
                        - DM
                        - DO
                        - DZ
                        - EC
                        - EE
                        - EG
                        - EH
                        - ER
                        - ES
                        - ET
                        - FI
                        - FJ
                        - FK
                        - FM
                        - FO
                        - FR
                        - GA
                        - GB
                        - GD
                        - GE
                        - GF
                        - GG
                        - GH
                        - GI
                        - GL
                        - GM
                        - GN
                        - GP
                        - GQ
                        - GR
                        - GS
                        - GT
                        - GU
                        - GW
                        - GY
                        - HK
                        - HM
                        - HN
                        - HR
                        - HT
                        - HU
                        - ID
                        - IE
                        - IL
                        - IM
                        - IN
                        - IO
                        - IQ
                        - IR
                        - IS
                        - IT
                        - JE
                        - JM
                        - JO
                        - JP
                        - KE
                        - KG
                        - KH
                        - KI
                        - KM
                        - KN
                        - KP
                        - KR
                        - KW
                        - KY
                        - KZ
                        - LA
                        - LB
                        - LC
                        - LI
                        - LK
                        - LR
                        - LS
                        - LT
                        - LU
                        - LV
                        - LY
                        - MA
                        - MC
                        - MD
                        - ME
                        - MF
                        - MG
                        - MH
                        - MK
                        - ML
                        - MM
                        - MN
                        - MO
                        - MP
                        - MQ
                        - MR
                        - MS
                        - MT
                        - MU
                        - MV
                        - MW
                        - MX
                        - MY
                        - MZ
                        - NA
                        - NC
                        - NE
                        - NF
                        - NG
                        - NI
                        - NL
                        - 'NO'
                        - NP
                        - NR
                        - NU
                        - NZ
                        - OM
                        - PA
                        - PE
                        - PF
                        - PG
                        - PH
                        - PK
                        - PL
                        - PM
                        - PN
                        - PR
                        - PS
                        - PT
                        - PW
                        - PY
                        - QA
                        - RE
                        - RO
                        - RS
                        - RU
                        - RW
                        - SA
                        - SB
                        - SC
                        - SD
                        - SE
                        - SG
                        - SH
                        - SI
                        - SJ
                        - SK
                        - SL
                        - SM
                        - SN
                        - SO
                        - SR
                        - SS
                        - ST
                        - SV
                        - SX
                        - SY
                        - SZ
                        - TC
                        - TD
                        - TF
                        - TG
                        - TH
                        - TJ
                        - TK
                        - TL
                        - TM
                        - TN
                        - TO
                        - TR
                        - TT
                        - TV
                        - TW
                        - TZ
                        - UA
                        - UG
                        - UM
                        - US
                        - UY
                        - UZ
                        - VA
                        - VC
                        - VE
                        - VG
                        - VI
                        - VN
                        - VU
                        - WF
                        - WS
                        - XK
                        - YE
                        - YT
                        - ZA
                        - ZM
                        - ZW
                    residentOfCode:
                      description: 'ISO ALPHA 2 country code for the primary country of residence for the individual

                        '
                      type: string
                    type:
                      type: string
                      enum:
                      - person
                      - organisation
                      - aircraft
                      - vessel
                    vesselCallSigns:
                      description: 'Array of known call signs for the vessel

                        '
                      type: array
                      minLength: 1
                      items:
                        type: string
                    vesselFlagsCode:
                      description: 'Array of ISO Alpha 2 country codes for flags under which the vessel may sail.

                        '
                      type: array
                      items:
                        type: string
                        maxLength: 2
                        minLength: 2
                        description: 'An ISO-3166 alpha-2 country code digraph as defined here: <https://www.iso.org/iso-3166-country-codes.html>

                          '
                        enum:
                        - AD
                        - AE
                        - AF
                        - AG
                        - AI
                        - AL
                        - AM
                        - AO
                        - AQ
                        - AR
                        - AS
                        - AT
                        - AU
                        - AW
                        - AX
                        - AZ
                        - BA
                        - BB
                        - BD
                        - BE
                        - BF
                        - BG
                        - BH
                        - BI
                        - BJ
                        - BL
                        - BM
                        - BN
                        - BO
                        - BQ
                        - BR
                        - BS
                        - BT
                        - BV
                        - BW
                        - BY
                        - BZ
                        - CA
                        - CC
                        - CD
                        - CF
                        - CG
                        - CH
                        - CI
                        - CK
                        - CL
                        - CM
                        - CN
                        - CO
                        - CR
                        - CU
                        - CV
                        - CW
                        - CX
                        - CY
                        - CZ
                        - DE
                        - DJ
                        - DK
                        - DM
                        - DO
                        - DZ
                        - EC
                        - EE
                        - EG
                        - EH
                        - ER
                        - ES
                        - ET
                        - FI
                        - FJ
                        - FK
                        - FM
                        - FO
                        - FR
                        - GA
                        - GB
                        - GD
                        - GE
                        - GF
                        - GG
                        - GH
                        - GI
                        - GL
                        - GM
                        - GN
                        - GP
                        - GQ
                        - GR
                        - GS
                        - GT
                        - GU
                        - GW
                        - GY
                        - HK
                        - HM
                        - HN
                        - HR
                        - HT
                        - HU
                        - ID
                        - IE
                        - IL
                        - IM
                        - IN
                        - IO
                        - IQ
                        - IR
                        - IS
                        - IT
                        - JE
                        - JM
                        - JO
                        - JP
                        - KE
                        - KG
                        - KH
                        - KI
                        - KM
                        - KN
                        - KP
                        - KR
                        - KW
                        - KY
                        - KZ
                        - LA
                        - LB
                        - LC
                        - LI
                        - LK
                        - LR
                        - LS
                        - LT
                        - LU
                        - LV
                        - LY
                        - MA
                        - MC
                        - MD
                        - ME
                        - MF
                        - MG
                        - MH
                        - MK
                        - ML
                        - MM
                        - MN
                        - MO
                        - MP
                        - MQ
                        - MR
                        - MS
                        - MT
                        - MU
                        - MV
                        - MW
                        - MX
                        - MY
                        - MZ
                        - NA
                        - NC
                        - NE
                        - NF
                        - NG
                        - NI
                        - NL
                        - 'NO'
                        - NP
                        - NR
                        - NU
                        - NZ
                        - OM
                        - PA
                        - PE
                        - PF
                        - PG
                        - PH
                        - PK
                        - PL
                        - PM
                        - PN
                        - PR
                        - PS
                        - PT
                        - PW
                        - PY
                        - QA
                        - RE
                        - RO
                        - RS
                        - RU
                        - RW
                        - SA
                        - SB
                        - SC
                        - SD
                        - SE
                        - SG
                        - SH
                        - SI
                        - SJ
                        - SK
                        - SL
                        - SM
                        - SN
                        - SO
                        - SR
                        - SS
                        - ST
                        - SV
                        - SX
                        - SY
                        - SZ
                        - TC
                        - TD
                        - TF
                        - TG
                        - TH
                        - TJ
                        - TK
                        - TL
                        - TM
                        - TN
                        - TO
                        - TR
                        - TT
                        - TV
                        - TW
                        - TZ
                        - UA
                        - UG
                        - UM
                        - US
                        - UY
                        - UZ
                        - VA
                        - VC
                        - VE
                        - VG
                        - VI
                        - VN
                        - VU
                        - WF
                        - WS
                        - XK
                        - YE
                        - YT
                        - ZA
                        - ZM
                        - ZW
                    vesselImoNumber:
                      description: 'The IMO number of the vessel if known.

                        '
                      type: string
      responses:
        '200':
          description: Clients finished streaming
          content:
            application/octet-stream:
              schema:
                discriminator:
                  propertyName: entityType
                  mapping:
                    PERSON: ./PersonClient.yaml
                    ORGANISATION: ./OrganisationClient.yaml
                    VESSEL: ./VesselClient.yaml
                    AIRCRAFT: ./AircraftClient.yaml
                anyOf:
                - type: object
                  allOf:
                  - type: object
                    required:
                    - objectType
                    - entityType
                    - clientId
                    properties:
                      objectType:
                        type: string
                        enum:
                        - client
                      clientId:
                        type: string
                      entityType:
                        type: string
                        enum:
                        - PERSON
                        - ORGANISATION
                        - VESSEL
                        - AIRCRAFT
                        - UNKNOWN
                      name:
                        type: string
                        maxLength: 460
                        minLength: 1
                        description: 'The full name of the client. This is a key field used in identity matching.

                          The name can be provided either as name parts, depending on the client type (i.e. first name, middle name, surname in the case of person clients) or as a complete name using this field. If name parts are provided, the system will construct the full name from those parts.

                          Names cannot be longer than 460 characters (assuming UTF-8 encoding) or 975 bytes, and it is recommended that names do not exceed 400 characters to ensure that Identity Matching can be done efficiently. Titles and suffixes are not included in this limit.

                          '
                      status:
                        type: string
                        enum:
                        - ACTIVE
                        - INACTIVE
                      freeTextItems:
                        type: array
                        items:
                          type: object
                          properties:
                            fieldId:
                              type: string
                            value:
                              type: string
                          required:
                          - fieldId
                          - value
                      addresses:
                        type: array
                        items:
                          type: object
                          properties:
                            line1:
                              type: string
                            line2:
                              type: string
                            line3:
                              type: string
                            line4:
                              type: string
                            poBox:
                              type: string
                            city:
                              type: string
                            state:
                              type: string
                            province:
                              type: string
                            country:
                              type: string
                            countryCode:
                              type: string
                              maxLength: 2
                              minLength: 2
                              description: 'An ISO-3166 alpha-2 country code digraph as defined here: <https://www.iso.org/iso-3166-country-codes.html>

                                '
                              enum:
                              - AD
                              - AE
                              - AF
                              - AG
                              - AI
                              - AL
                              - AM
                              - AO
                              - AQ
                              - AR
                              - AS
                              - AT
                              - AU
                              - AW
                              - AX
                              - AZ
                              - BA
                              - BB
                              - BD
                              - BE
                              - BF
                              - BG
                              - BH
                              - BI
                              - BJ
                              - BL
                              - BM
                              - BN
                              - BO
                              - BQ
                              - BR
                              - BS
                              - BT
                              - BV
                              - BW
                              - BY
                              - BZ
                              - CA
                              - CC
                              - CD
                              - CF
                              - CG
                              - CH
                              - CI
                              - CK
                              - CL
                              - CM
                              - CN
                              - CO
                              - CR
                              - CU
                              - CV
                              - CW
                              - CX
                              - CY
                              - CZ
                              - DE
                              - DJ
                              - DK
                              - DM
                              - DO
                              - DZ
                              - EC
                              - EE
                              - EG
                              - EH
                              - ER
                              - ES
                              - ET
                              - FI
                              - FJ
                              - FK
                              - FM
                              - FO
                              - FR
                              - GA
                              - GB
                              - GD
                              - GE
                              - GF
                              - GG
                              - GH
                              - GI
                              - GL
                              - GM
                              - GN
                              - GP
                              - GQ
                              - GR
                              - GS
                              - GT
                              - GU
                              - GW
                              - GY
                              - HK
                              - HM
                              - HN
                              - HR
                              - HT
                              - HU
                              - ID
                              - IE
                              - IL
                              - IM
                      

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