Dow Jones Screening and Monitoring Private Lists API
Manage private watchlists used in screening alongside Dow Jones Risk & Compliance content sets.
OpenAPI Specification
{
"openapi": "3.0.1",
"info": {
"title": "Screening and Monitoring Private Lists API",
"contact": {
"name": "Dow Jones"
},
"license": {
"name": "Dow Jones Screening and Monitoring Private Lists API"
},
"version": "v1"
},
"servers": [
{
"url": "https://api.dowjones.com"
},
{
"url": "https://eu.api.dowjones.com"
}
],
"tags": [{
"name": "Custom Sources",
"description": "Operations related to the custom sources"
},
{
"name": "Profiles",
"description": "Operations related to the profiles"
},
{
"name": "Transaction",
"description": "Operations related to the transactions"
}
],
"paths": {
"/risk-profiles-custom-sources": {
"get": {
"tags": [
"Custom Sources"
],
"summary": "Retrieves the information of the Profiles Custom Sources from the given account",
"operationId": "getProfileSourcesUsingGET",
"parameters": [{
"$ref": "#/components/parameters/Accept-Encoding"
},
{
"name": "page[offset]",
"in": "query",
"description": "page offset",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "page[limit]",
"in": "query",
"description": "page limit",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/ResponseDataProfileSources"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
}
},
"security": [{
"bearerAuth": []
}]
},
"post": {
"tags": [
"Custom Sources"
],
"summary": "Creates a new Profiles Custom Source",
"operationId": "createProfileSourceUsingPOST",
"parameters": [{
"$ref": "#/components/parameters/Accept-Encoding"
},
{
"$ref": "#/components/parameters/Content-Encoding"
}
],
"requestBody": {
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/RequestDataProfileSourceName"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestDataProfileSourceName"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/ResponseProfileSourceName"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
}
},
"security": [{
"bearerAuth": []
}]
}
},
"/risk-profiles-custom-sources/{id}": {
"get": {
"tags": [
"Custom Sources"
],
"summary": "Retrieves the attributes of the Profiles Custom Source",
"operationId": "retrieveGroupInfoUsingGET",
"parameters": [{
"$ref": "#/components/parameters/Accept-Encoding"
},
{
"name": "id",
"in": "path",
"description": "Id of the source.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/ResponseDataListProfileSourcesInformation"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
}
},
"security": [{
"bearerAuth": []
}]
},
"delete": {
"tags": [
"Custom Sources"
],
"summary": "Deletes a Profiles Custom Source",
"operationId": "deleteProfileSourceUsingDELETE",
"parameters": [{
"name": "id",
"in": "path",
"description": "Id of the source.",
"required": true,
"schema": {
"type": "string"
}
}],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
}
},
"security": [{
"bearerAuth": []
}]
},
"patch": {
"tags": [
"Custom Sources"
],
"summary": "Modifies a Profiles Custom Source Name",
"operationId": "updateSourceNameUsingPATCH",
"parameters": [{
"$ref": "#/components/parameters/Accept-Encoding"
},
{
"$ref": "#/components/parameters/Content-Encoding"
},
{
"name": "id",
"in": "path",
"description": "Id of the source.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "request",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/RequestDataProfileSourceName"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestDataProfileSourceName"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/ResponseProfileSourceName"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/vnd.dowjones.dna.risk-profiles-custom-sources.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
}
},
"security": [{
"bearerAuth": []
}]
}
},
"/risk-profiles-custom-sources/{id}/profiles": {
"get": {
"tags": [
"Profiles"
],
"summary": "Retrieves all profiles from a custom source",
"operationId": "retrieveAllProfilesOnACustomSourceUsingGET",
"parameters": [{
"$ref": "#/components/parameters/Accept-Encoding"
},
{
"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, should not be higher than 500",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"maximum": 500,
"default": 100
}
},
{
"name": "parts",
"in": "query",
"description": "Specifies if the profiles should be returned with all attributes or only the ids.\n * all_attributes - Return all attributes for the profiles\n * id_only - Returns only the profile ids (Default value)\n",
"example": "id_only",
"required": false,
"schema": {
"type": "string",
"enum": [
"all_attributes",
"id_only"
]
}
},
{
"name": "id",
"in": "path",
"description": "Id of the custom source.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/vnd.dowjones.dna.profiles.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/ResponseDataGetAllProfiles"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/vnd.dowjones.dna.profiles.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/vnd.dowjones.dna.profiles.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/vnd.dowjones.dna.profiles.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
}
},
"security": [{
"bearerAuth": []
}]
},
"post": {
"tags": [
"Profiles"
],
"summary": "Inserts one or more profiles",
"operationId": "insertProfileUsingPOST",
"parameters": [{
"$ref": "#/components/parameters/Accept-Encoding"
},
{
"$ref": "#/components/parameters/Content-Encoding"
},
{
"name": "id",
"in": "path",
"description": "Id of the source.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.dowjones.dna.profiles.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/RequestDataInsertProfile"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestDataInsertProfile"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/vnd.dowjones.dna.transactions.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/ResponseDataInsertTransaction"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/vnd.dowjones.dna.transactions.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/vnd.dowjones.dna.transactions.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/vnd.dowjones.dna.transactions.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
}
},
"security": [{
"bearerAuth": []
}]
}
},
"/risk-profiles-custom-sources/{id}/profiles/{peid}": {
"get": {
"tags": [
"Profiles"
],
"summary": "Retrieves a Profile",
"operationId": "retrieveProfileUsingGET",
"parameters": [{
"$ref": "#/components/parameters/Accept-Encoding"
},
{
"name": "id",
"in": "path",
"description": "Id of the source.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "peid",
"in": "path",
"description": "Id of the profile.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/vnd.dowjones.dna.profiles.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/ResponseDataProfileId"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/vnd.dowjones.dna.profiles.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/vnd.dowjones.dna.profiles.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/vnd.dowjones.dna.profiles.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
}
},
"security": [{
"bearerAuth": []
}]
},
"put": {
"tags": [
"Profiles"
],
"summary": "Updates a profile",
"operationId": "updateProfileUsingPUT",
"parameters": [{
"$ref": "#/components/parameters/Accept-Encoding"
},
{
"$ref": "#/components/parameters/Content-Encoding"
},
{
"name": "id",
"in": "path",
"description": "Id of the source.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "peid",
"in": "path",
"description": "Id of the profile.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.dowjones.dna.profiles.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/RequestDataPutProfile"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestDataPutProfile"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/vnd.dowjones.dna.transactions.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/ResponseDataInsertTransaction"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/vnd.dowjones.dna.transactions.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/vnd.dowjones.dna.transactions.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/vnd.dowjones.dna.transactions.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
}
},
"security": [{
"bearerAuth": []
}]
},
"delete": {
"tags": [
"Profiles"
],
"summary": "Removes a profile",
"operationId": "removeProfileUsingDELETE",
"parameters": [{
"name": "id",
"in": "path",
"description": "Id of the source.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "peid",
"in": "path",
"description": "Id of the profile.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized",
"content": {
"application/vnd.dowjones.dna.profiles.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/vnd.dowjones.dna.profiles.v_1.0+json": {
"schema": {
"$ref": "#/components/schemas/JsonError"
}
# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dow-jones/refs/heads/main/openapi/dow-jones-screening-and-monitoring-private-lists-api-openapi.json