Dow Jones Screening and Monitoring API

Case-based batch screening of people and entities against Dow Jones Risk & Compliance data, with associations, matches, and adjudication workflows.

OpenAPI Specification

dow-jones-screening-and-monitoring-api-openapi.json Raw ↑
{
  "openapi": "3.0.1",
  "info": {
    "title": "Screening and Monitoring API",
    "description": "RESTful API that enables your client application to screen and monitor\nthird parties (individuals and entities) against Dow Jones Risk &\nCompliance data. Supports cases, associations, matches, and bulk operations.\n",
    "contact": {
      "name": "Dow Jones"
    },
    "license": {
      "name": "A RESTful API that enables your client application to screen and monitor third parties - individuals and entities - against Dow Jones Risk & Compliance data."
    },
    "version": "v7.3"
  },
  "servers": [
    {
      "url": "https://api.dowjones.com"
    },
    {
      "url": "https://eu.api.dowjones.com"
    }
  ],
  "tags": [
    {
      "name": "Risk and Compliance Screening and Monitoring",
      "description": "APIs for screening and monitoring third parties against Dow Jones Risk & Compliance data."
    }
  ],
  "paths": {
    "/risk-entity-screening-associations": {
      "get": {
        "tags": [
          "Risk and Compliance Screening and Monitoring"
        ],
        "summary": "Retrieves all associations",
        "description": "Retrieves all associations for the account with optional filters and pagination.",
        "operationId": "getAssociationsUsingGET",
        "parameters": [
          {
            "name": "page[offset]",
            "in": "query",
            "description": "Page offset.",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          },
          {
            "name": "page[limit]",
            "in": "query",
            "description": "Page limit.",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 100
            }
          },
          {
            "name": "filter[correlated]",
            "in": "query",
            "description": "Filters associations by if they are correlated or not to any case.",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "true",
                "false",
                "any"
              ]
            }
          },
          {
            "name": "Accept-Encoding",
            "in": "header",
            "description": "Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to \"gzip\" and the payload exceeds the threshold of 8MB",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.0+json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseListAssociation"
                },
                "example": {
                  "data": [
                    {
                      "attributes": {
                        "gender": "MALE",
                        "country": "USA",
                        "record_type": "PERSON",
                        "names": [
                          {
                            "name_type": "PRIMARY",
                            "first_name": "John",
                            "middle_name": "Michael",
                            "last_name": "Doe"
                          }
                        ],
                        "identification_details": {},
                        "timestamp": "2025-01-15T12:00:00",
                        "year_of_birth": 1970
                      },
                      "type": "risk-entity-screening-associations",
                      "links": {
                        "self": "https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001"
                      },
                      "id": "00000000-0000-0000-0000-000000000001"
                    },
                    {
                      "attributes": {
                        "country": "USA",
                        "record_type": "ENTITY",
                        "names": [
                          {
                            "name_type": "PRIMARY",
                            "single_string_name": "Acme Corp"
                          }
                        ],
                        "identification_details": {
                          "type": 1006,
                          "value": "Duns123"
                        },
                        "external_id": "ext-001",
                        "timestamp": "2025-01-15T12:00:00"
                      },
                      "type": "risk-entity-screening-associations",
                      "links": {
                        "self": "https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002"
                      },
                      "id": "00000000-0000-0000-0000-000000000002"
                    }
                  ],
                  "links": {
                    "first": "https://api.example.com/risk-entity-screening-associations?page[limit]=100&filter[correlated]=false&page[offset]=0",
                    "last": "https://api.example.com/risk-entity-screening-associations?page[limit]=100&filter[correlated]=false&page[offset]=0"
                  },
                  "meta": {
                    "count": 2,
                    "offset": {
                      "first": "0",
                      "last": "0"
                    },
                    "total_count": 2
                  }
                }
              },
              "application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.1+json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseListAssociation"
                },
                "example": {
                  "data": [
                    {
                      "attributes": {
                        "gender": "MALE",
                        "country": "USA",
                        "record_type": "PERSON",
                        "names": [
                          {
                            "name_type": "PRIMARY",
                            "first_name": "John",
                            "middle_name": "Michael",
                            "last_name": "Doe"
                          }
                        ],
                        "identification_details": {},
                        "timestamp": "2025-01-15T12:00:00",
                        "year_of_birth": 1970
                      },
                      "type": "risk-entity-screening-associations",
                      "links": {
                        "self": "https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001"
                      },
                      "id": "00000000-0000-0000-0000-000000000001"
                    },
                    {
                      "attributes": {
                        "record_type": "ENTITY",
                        "names": [
                          {
                            "name_type": "PRIMARY",
                            "single_string_name": "Acme Corp"
                          }
                        ],
                        "identification_details": {
                          "type": 1006,
                          "value": "Duns123"
                        },
                        "external_id": "ext-001",
                        "timestamp": "2025-01-15T12:00:00"
                      },
                      "type": "risk-entity-screening-associations",
                      "links": {
                        "self": "https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002"
                      },
                      "id": "00000000-0000-0000-0000-000000000002"
                    }
                  ],
                  "links": {
                    "last": "https://api.example.com/risk-entity-screening-associations?page[limit]=20&page[offset]=0",
                    "first": "https://api.example.com/risk-entity-screening-associations?page[limit]=20&page[offset]=0"
                  },
                  "meta": {
                    "count": 2,
                    "offset": {
                      "last": "0",
                      "first": "0"
                    },
                    "total_count": 2
                  }
                }
              },
              "application/vnd.dowjones.dna.risk-entity-screening-associations.v_2.0+json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseListAssociationV20"
                },
                "example": {
                  "data": [
                    {
                      "attributes": {
                        "gender": "MALE",
                        "country": "USA",
                        "record_type": "PERSON",
                        "names": [
                          {
                            "name_type": "PRIMARY",
                            "first_name": "John",
                            "middle_name": "Michael",
                            "last_name": "Doe"
                          }
                        ],
                        "identification_details": {},
                        "timestamp": "2025-01-15T12:00:00",
                        "year_of_birth": {
                          "specific_year": 1970
                        },
                        "is_deceased": false
                      },
                      "type": "risk-entity-screening-associations",
                      "links": {
                        "self": "https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001"
                      },
                      "id": "00000000-0000-0000-0000-000000000001"
                    },
                    {
                      "attributes": {
                        "country": "UK",
                        "record_type": "PERSON",
                        "names": [
                          {
                            "name_type": "PRIMARY",
                            "first_name": "Jane",
                            "last_name": "Smith"
                          }
                        ],
                        "identification_details": {},
                        "timestamp": "2025-01-15T12:00:00",
                        "year_of_birth": {
                          "from": 1980,
                          "to": 1985
                        },
                        "gender": "FEMALE",
                        "external_id": "ext-002"
                      },
                      "type": "risk-entity-screening-associations",
                      "links": {
                        "self": "https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002"
                      },
                      "id": "00000000-0000-0000-0000-000000000002"
                    },
                    {
                      "attributes": {
                        "country": "USA",
                        "record_type": "ENTITY",
                        "names": [
                          {
                            "name_type": "PRIMARY",
                            "single_string_name": "Acme Corp"
                          }
                        ],
                        "identification_details": {
                          "type": 1006,
                          "value": "Duns123"
                        },
                        "external_id": "ext-003",
                        "timestamp": "2025-01-15T12:00:00",
                        "industry_sector": "Technology"
                      },
                      "type": "risk-entity-screening-associations",
                      "links": {
                        "self": "https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000003"
                      },
                      "id": "00000000-0000-0000-0000-000000000003"
                    }
                  ],
                  "links": {
                    "first": "https://api.example.com/risk-entity-screening-associations?page[limit]=20&page[offset]=0",
                    "last": "https://api.example.com/risk-entity-screening-associations?page[limit]=20&page[offset]=0"
                  },
                  "meta": {
                    "count": 3,
                    "offset": {
                      "last": "0",
                      "first": "0"
                    },
                    "total_count": 3
                  }
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseListAssociation"
                },
                "example": {
                  "data": [
                    {
                      "attributes": {
                        "gender": "MALE",
                        "country": "USA",
                        "record_type": "PERSON",
                        "names": [
                          {
                            "name_type": "PRIMARY",
                            "first_name": "John",
                            "middle_name": "Michael",
                            "last_name": "Doe"
                          }
                        ],
                        "identification_details": {},
                        "timestamp": "2025-01-15T12:00:00",
                        "year_of_birth": 1970
                      },
                      "type": "risk-entity-screening-associations",
                      "links": {
                        "self": "https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001"
                      },
                      "id": "00000000-0000-0000-0000-000000000001"
                    },
                    {
                      "attributes": {
                        "country": "USA",
                        "record_type": "ENTITY",
                        "names": [
                          {
                            "name_type": "PRIMARY",
                            "single_string_name": "Acme Corp"
                          }
                        ],
                        "identification_details": {
                          "type": 1006,
                          "value": "Duns123"
                        },
                        "external_id": "ext-001",
                        "timestamp": "2025-01-15T12:00:00"
                      },
                      "type": "risk-entity-screening-associations",
                      "links": {
                        "self": "https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000002"
                      },
                      "id": "00000000-0000-0000-0000-000000000002"
                    }
                  ],
                  "links": {
                    "first": "https://api.example.com/risk-entity-screening-associations?page[limit]=100&filter[correlated]=false&page[offset]=0",
                    "last": "https://api.example.com/risk-entity-screening-associations?page[limit]=100&filter[correlated]=false&page[offset]=0"
                  },
                  "meta": {
                    "count": 2,
                    "offset": {
                      "first": "0",
                      "last": "0"
                    },
                    "total_count": 2
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {}
          },
          "403": {
            "description": "Forbidden",
            "content": {}
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      },
      "post": {
        "tags": [
          "Risk and Compliance Screening and Monitoring"
        ],
        "summary": "Adds a new association",
        "description": "Creates a new risk-entity-screening association for the account.\nWhen using versioned media types, the Accept and Content-Type headers must use the same version; otherwise the API returns 406 Not Acceptable.\n",
        "operationId": "postAssociationUsingPOST",
        "parameters": [
          {
            "name": "Accept-Encoding",
            "in": "header",
            "description": "Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to \"gzip\" and the payload exceeds the threshold of 8MB",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Content-Encoding",
            "in": "header",
            "description": "Which encoding the request body is being sent. The API supports gzip encoding for request body.",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "request",
          "content": {
            "application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.0+json": {
              "schema": {
                "$ref": "#/components/schemas/RequestAssociation"
              },
              "example": {
                "data": {
                  "attributes": {
                    "record_type": "PERSON",
                    "names": [
                      {
                        "name_type": "PRIMARY",
                        "first_name": "John",
                        "last_name": "Doe"
                      }
                    ],
                    "identification_details": {
                      "type": 1023,
                      "value": "Passport123"
                    },
                    "year_of_birth": 1970,
                    "country": "USA",
                    "external_id": "ext-001"
                  },
                  "type": "risk-entity-screening-associations"
                }
              }
            },
            "application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.1+json": {
              "schema": {
                "$ref": "#/components/schemas/RequestAssociationV11"
              },
              "example": {
                "data": {
                  "attributes": {
                    "record_type": "PERSON",
                    "names": [
                      {
                        "name_type": "PRIMARY",
                        "first_name": "John",
                        "last_name": "Doe"
                      }
                    ],
                    "identification_details": {
                      "type": 1023,
                      "value": "Passport123"
                    },
                    "year_of_birth": 1970,
                    "country": "USA",
                    "external_id": "ext-001"
                  },
                  "type": "risk-entity-screening-associations"
                }
              }
            },
            "application/vnd.dowjones.dna.risk-entity-screening-associations.v_2.0+json": {
              "schema": {
                "$ref": "#/components/schemas/RequestAssociationV20"
              },
              "example": {
                "data": {
                  "attributes": {
                    "record_type": "PERSON",
                    "names": [
                      {
                        "name_type": "PRIMARY",
                        "first_name": "John",
                        "last_name": "Doe"
                      }
                    ],
                    "identification_details": {
                      "type": 1023,
                      "value": "Passport123"
                    },
                    "year_of_birth": {
                      "from": 1968,
                      "to": 1972
                    },
                    "country": "USA",
                    "external_id": "ext-001"
                  },
                  "type": "risk-entity-screening-associations"
                }
              }
            },
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RequestAssociation"
              },
              "example": {
                "data": {
                  "attributes": {
                    "record_type": "PERSON",
                    "names": [
                      {
                        "name_type": "PRIMARY",
                        "first_name": "John",
                        "last_name": "Doe"
                      }
                    ],
                    "identification_details": {
                      "type": 1023,
                      "value": "Passport123"
                    },
                    "year_of_birth": 1970,
                    "country": "USA",
                    "external_id": "ext-001"
                  },
                  "type": "risk-entity-screening-associations"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Created",
            "content": {
              "application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.0+json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseAssociation"
                },
                "example": {
                  "data": {
                    "attributes": {
                      "country": "USA",
                      "record_type": "PERSON",
                      "names": [
                        {
                          "name_type": "PRIMARY",
                          "first_name": "John",
                          "last_name": "Doe"
                        }
                      ],
                      "identification_details": {
                        "type": 1023,
                        "value": "Passport123"
                      },
                      "external_id": "ext-001",
                      "timestamp": "2025-01-15T12:00:00",
                      "year_of_birth": 1970
                    },
                    "type": "risk-entity-screening-associations",
                    "links": {
                      "self": "https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001"
                    },
                    "id": "00000000-0000-0000-0000-000000000001"
                  }
                }
              },
              "application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.1+json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseAssociation"
                },
                "example": {
                  "data": {
                    "attributes": {
                      "country": "USA",
                      "record_type": "PERSON",
                      "names": [
                        {
                          "name_type": "PRIMARY",
                          "first_name": "John",
                          "last_name": "Doe"
                        }
                      ],
                      "identification_details": {
                        "type": 1023,
                        "value": "Passport123"
                      },
                      "external_id": "ext-001",
                      "timestamp": "2025-01-15T12:00:00",
                      "year_of_birth": 1970
                    },
                    "type": "risk-entity-screening-associations",
                    "links": {
                      "self": "https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001"
                    },
                    "id": "00000000-0000-0000-0000-000000000001"
                  }
                }
              },
              "application/vnd.dowjones.dna.risk-entity-screening-associations.v_2.0+json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseAssociationV20"
                },
                "example": {
                  "data": {
                    "attributes": {
                      "country": "USA",
                      "record_type": "PERSON",
                      "names": [
                        {
                          "name_type": "PRIMARY",
                          "first_name": "John",
                          "last_name": "Doe"
                        }
                      ],
                      "identification_details": {
                        "type": 1023,
                        "value": "Passport123"
                      },
                      "external_id": "ext-001",
                      "timestamp": "2025-01-15T12:00:00",
                      "year_of_birth": {
                        "from": 1968,
                        "to": 1972
                      }
                    },
                    "type": "risk-entity-screening-associations",
                    "links": {
                      "self": "https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001"
                    },
                    "id": "00000000-0000-0000-0000-000000000001"
                  }
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseAssociation"
                },
                "example": {
                  "data": {
                    "attributes": {
                      "country": "USA",
                      "record_type": "PERSON",
                      "names": [
                        {
                          "name_type": "PRIMARY",
                          "first_name": "John",
                          "last_name": "Doe"
                        }
                      ],
                      "identification_details": {
                        "type": 1023,
                        "value": "Passport123"
                      },
                      "external_id": "ext-001",
                      "timestamp": "2025-01-15T12:00:00",
                      "year_of_birth": 1970
                    },
                    "type": "risk-entity-screening-associations",
                    "links": {
                      "self": "https://api.example.com/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001"
                    },
                    "id": "00000000-0000-0000-0000-000000000001"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JsonError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {}
          },
          "403": {
            "description": "Forbidden",
            "content": {}
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ]
      }
    },
    "/risk-entity-screening-associations/{association_id}": {
      "get": {
        "tags": [
          "Risk and Compliance Screening and Monitoring"
        ],
        "summary": "Retrieves an association by ID",
        "description": "Returns a single association by its ID.",
        "operationId": "getAssociationUsingGET",
        "parameters": [
          {
            "name": "Accept-Encoding",
            "in": "header",
            "description": "Which encoding the user accepts for the response body. The API supports compression for response body if this header is set to \"gzip\" and the payload exceeds the threshold of 8MB",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "association_id",
            "in": "path",
            "description": "Id of the Association.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.0+json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseAssociation"
                },
                "example": {
                  "data": {
                    "attributes": {
                      "country": "USA",
                      "record_type": "PERSON",
                      "names": [
                        {
                          "name_type": "PRIMARY",
                          "first_name": "John",
                          "last_name": "Doe"
                        }
                      ],
                      "identification_details": {
                        "type": 1023,
                        "value": "Passport123"
                      },
                      "external_id": "ext-001",
                      "timestamp": "2026-02-11T17:21:42",
                      "year_of_birth": 1970
                    },
                    "type": "risk-entity-screening-associations",
                    "links": {
                      "self": "https://api.dowjones.io/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001"
                    },
                    "id": "00000000-0000-0000-0000-000000000001"
                  }
                }
              },
              "application/vnd.dowjones.dna.risk-entity-screening-associations.v_1.1+json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseAssociation"
                },
                "example": {
                  "data": {
                    "attributes": {
                      "country": "USA",
                      "record_type": "PERSON",
                      "names": [
                        {
                          "name_type": "PRIMARY",
                          "first_name": "John",
                          "last_name": "Doe"
                        }
                      ],
                      "identification_details": {
                        "type": 1023,
                        "value": "Passport123"
                      },
                      "external_id": "ext-001",
                      "timestamp": "2026-02-11T17:21:42",
                      "year_of_birth": 1970,
                      "gender": "MALE",
                      "is_deceased": false
                    },
                    "type": "risk-entity-screening-associations",
                    "links": {
                      "self": "https://api.dowjones.io/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001"
                    },
                    "id": "00000000-0000-0000-0000-000000000001"
                  }
                }
              },
              "application/vnd.dowjones.dna.risk-entity-screening-associations.v_2.0+json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseAssociationV20"
                },
                "example": {
                  "data": {
                    "attributes": {
                      "country": "USA",
                      "record_type": "PERSON",
                      "names": [
                        {
                          "name_type": "PRIMARY",
                          "first_name": "John",
                          "last_name": "Doe"
                        }
                      ],
                      "identification_details": {
                        "type": 1023,
                        "value": "Passport123"
                      },
                      "external_id": "ext-001",
                      "timestamp": "2026-02-11T17:21:42",
                      "year_of_birth": {
                        "specific_year": 1970
                      }
                    },
                    "type": "risk-entity-screening-associations",
                    "links": {
                      "self": "https://api.dowjones.io/risk-entity-screening-associations/00000000-0000-0000-0000-000000000001"
     

# --- truncated at 32 KB (425 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dow-jones/refs/heads/main/openapi/dow-jones-screening-and-monitoring-api-openapi.json