Dow Jones Due Diligence Reports API

Order and retrieve Risk & Compliance due-diligence reports (Risk Reports order tool).

OpenAPI Specification

dow-jones-due-diligence-reports-api-openapi.json Raw ↑
{
  "openapi": "3.0.0",
  "info": {
    "title": "Risk & Compliance Risk Reports",
    "version": "1.18.11"
  },
  "tags": [
    {
      "name": "Risk Reports",
      "description": "API"
    }
  ],
  "components": {
    "schemas": {
      "billingaccount_dataitem": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "example": "billing_accounts"
          },
          "id": {
            "type": "string",
            "example": "9PRO000200"
          },
          "attributes": {
            "type": "object",
            "$ref": "#/components/schemas/billing_account"
          }
        }
      },
      "billing_account": {
        "type": "object",
        "properties": {
          "currency_code": {
            "type": "string",
            "enum": [
              "AUD",
              "BRL",
              "USD",
              "EUR",
              "GBP",
              "INR",
              "JPY",
              "CAD",
              "CNY",
              "CHF",
              "SGD",
              "ZAR"
            ]
          },
          "report_types": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "example": "Red Flag"
                },
                "value": {
                  "type": "string",
                  "example": "redflag"
                }
              }
            }
          },
          "owner": {
            "type": "object",
            "properties": {
              "company_name": {
                "type": "string",
                "example": "Hooli XYZ"
              }
            }
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "example": "2018-09-26T00:00:00.000Z"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "example": "2018-09-26T00:00:00.000Z"
          }
        }
      },
      "get_billingaccounts_response": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/billingaccount_dataitem"
            }
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "string",
                "format": "hostname",
                "example": "https://api.dowjones.com/risk-reports/billing-accounts"
              }
            }
          }
        }
      },
      "comment_dataitem": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "example": "comments"
          },
          "id": {
            "type": "string",
            "example": "d3a9c83656cd4a30814b1466e9689fbb"
          },
          "links": {
            "type": "object",
            "properties": {
              "reportRequest": {
                "type": "string",
                "example": "http://api.dowjones.com/risk-reports/reportrequests/ba6e0ef7eda8481ca9b8db7112fb03bf"
              }
            }
          },
          "attributes": {
            "type": "object",
            "$ref": "#/components/schemas/comment"
          },
          "relationships": {
            "type": "object",
            "properties": {
              "user": {
                "type": "object",
                "properties": {
                  "data": {
                    "type": "object",
                    "properties": {
                      "type": {
                        "type": "string",
                        "example": "users"
                      },
                      "id": {
                        "type": "string",
                        "example": "E6OO2HVCQHVPE5X54D7W7XO5NI"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "create_comment_response": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "$ref": "#/components/schemas/comment_dataitem"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "string",
                "format": "hostname",
                "example": "https://api.dowjones.com/risk-reports/reportrequests/d5ee7ceb98a848a49420d7cce2601934/comments"
              }
            }
          },
          "included": {
            "type": "array",
            "items": {
              "type": "object",
              "$ref": "#/components/schemas/user_data_item"
            }
          }
        }
      },
      "comment_response": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/comment_dataitem"
            }
          },
          "links": {
            "type": "object",
            "properties": {
              "reportRequest": {
                "type": "string",
                "format": "hostname",
                "example": "https://api.dowjones.com/risk-reports/reportrequests/d5ee7ceb98a848a49420d7cce2601934"
              }
            }
          },
          "included": {
            "type": "array",
            "items": {
              "type": "object",
              "$ref": "#/components/schemas/user_data_item"
            }
          }
        }
      },
      "comment": {
        "type": "object",
        "properties": {
          "content": {
            "type": "string",
            "example": "Hello world!"
          },
          "is_urgent": {
            "type": "boolean",
            "example": false
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "example": "2018-09-26T00:00:00.000Z"
          }
        }
      },
      "comment_create": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "attributes": {
                "type": "object",
                "properties": {
                  "content": {
                    "type": "string",
                    "example": "Hello world!"
                  },
                  "is_urgent": {
                    "type": "boolean",
                    "example": false
                  }
                },
                "required": [
                  "content",
                  "is_urgent"
                ]
              }
            },
            "required": [
              "attributes"
            ]
          }
        },
        "required": [
          "data"
        ],
        "additionalProperties": false
      },
      "document": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "8e1f7433184a4b59b8a3dd22bbe51537"
          },
          "file_name": {
            "type": "string",
            "example": "doc.txt"
          },
          "mimetype": {
            "type": "string",
            "example": "\"text/plain"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "example": "2018-09-26T00:00:00.000Z"
          },
          "size": {
            "type": "number",
            "example": 2048
          }
        }
      },
      "document_dataitem": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "example": "documents"
          },
          "id": {
            "type": "string",
            "example": "2009e814baef455fb7b062d0904d3a19"
          },
          "attributes": {
            "type": "object",
            "$ref": "#/components/schemas/document"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "string",
                "format": "hostname",
                "example": "https://api.dowjones.com/risk-reports/reportrequests/d5ee7ceb98a848a49420d7cce2601934/documents/4a68c4aaa8844043b8e2827b8d0f1948"
              },
              "reportRequest": {
                "type": "string",
                "format": "hostname",
                "example": "https://api.dowjones.com/risk-reports/reportrequests/d5ee7ceb98a848a49420d7cce2601934"
              }
            }
          }
        }
      },
      "document_response": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "$ref": "#/components/schemas/document_dataitem"
          }
        }
      },
      "documents_response": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/document_dataitem"
            }
          }
        }
      },
      "document_links": {
        "type": "object",
        "properties": {
          "self": {
            "type": "string"
          },
          "download": {
            "type": "string"
          }
        }
      },
      "bad_request_error_response": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/bad_request_error"
            }
          }
        },
        "required": [
          "errors"
        ]
      },
      "bad_request_error_detail": {
        "type": "object",
        "properties": {
          "pointer": {
            "description": "a JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute]",
            "example": "/data/attributes",
            "type": "string"
          }
        },
        "required": [
          "key"
        ]
      },
      "bad_request_links": {
        "type": "object",
        "properties": {
          "about": {
            "description": "a link that leads to further details about this particular occurrence of the problem",
            "example": "https://wiki.dowjones.net/display/DSE/Error+Codes",
            "type": "string"
          }
        },
        "required": [
          "key"
        ]
      },
      "bad_request_error": {
        "type": "object",
        "properties": {
          "id": {
            "description": "a unique identifier for this particular occurrence of the problem.",
            "example": "d5ee7ceb98a848a49420d7cce2601934",
            "type": "string"
          },
          "status": {
            "description": "the HTTP status code applicable to this problem, expressed as a string value.",
            "example": "400",
            "type": "string"
          },
          "code": {
            "description": "an application-specific error code, expressed as a string value.",
            "example": "302",
            "type": "string"
          },
          "source": {
            "type": "object",
            "$ref": "#/components/schemas/bad_request_error_detail"
          },
          "links": {
            "type": "object",
            "$ref": "#/components/schemas/bad_request_links"
          },
          "meta": {
            "description": "a meta object containing non-standard meta-information about the error",
            "type": "string"
          },
          "title": {
            "description": "a short, human-readable summary of the problem",
            "example": "Missing required property: name",
            "type": "string"
          },
          "detail": {
            "description": "a human-readable explanation specific to this occurrence of the problem",
            "example": "/data/attributes Missing required property: name",
            "type": "string"
          }
        },
        "required": [
          "title",
          "detail",
          "source"
        ]
      },
      "proposals_response": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "object",
                  "$ref": "#/components/schemas/report_request_rush_proposal_attributes"
                },
                {
                  "type": "object",
                  "$ref": "#/components/schemas/report_request_price_proposal_attributes"
                },
                {
                  "type": "object",
                  "$ref": "#/components/schemas/report_request_update_proposal_attributes"
                }
              ]
            }
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "string",
                "format": "hostname",
                "example": "https://api.dowjones.com/risk-reports/reportrequests/88e6e35adcb346e2b10dc14447419bc9/proposals"
              }
            }
          }
        }
      },
      "proposal_response": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "$ref": "#/components/schemas/proposal_dataitem"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "string",
                "format": "hostname",
                "example": "https://api.dowjones.com/risk-reports/reportrequests/88e6e35adcb346e2b10dc14447419bc9/proposals"
              }
            }
          }
        }
      },
      "proposal_dataitem": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "example": "proposals"
          },
          "id": {
            "type": "string",
            "example": "88e6e35adcb346e2b10dc14447419bc9"
          },
          "links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "string",
                "example": "http://api.dowjones.com/risk-reports/reportrequests/09bb9570e3254f96b2e89bb3ef56655b/proposals/88e6e35adcb346e2b10dc14447419bc9"
              }
            }
          },
          "attributes": {
            "type": "object",
            "oneOf": [
              {
                "type": "object",
                "$ref": "#/components/schemas/report_request_update_proposal_attributes"
              },
              {
                "type": "object",
                "$ref": "#/components/schemas/report_request_price_proposal_attributes"
              },
              {
                "type": "object",
                "$ref": "#/components/schemas/report_request_rush_proposal_attributes"
              }
            ]
          }
        }
      },
      "report_request_rush_proposal_attributes": {
        "type": "object",
        "properties": {
          "proposal": {
            "type": "string",
            "description": "Rush Report",
            "default": "rush"
          },
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "fsdds5a4264227477ad23fsas222d2223"
          },
          "params": {
            "$ref": "#/components/schemas/report_request_params_rush"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "approved",
              "rejected"
            ],
            "default": "pending"
          },
          "initiated_date": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "report_request_price_proposal_attributes": {
        "type": "object",
        "properties": {
          "proposal": {
            "type": "string",
            "description": "Additions or Changes in the price",
            "default": "additional_price"
          },
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "ffc5a42642274771be036b927eaaf6af"
          },
          "params": {
            "$ref": "#/components/schemas/report_request_params_price"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "approved",
              "rejected"
            ],
            "default": "pending"
          },
          "initiated_date": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "report_request_update_proposal_attributes": {
        "type": "object",
        "properties": {
          "proposal": {
            "type": "string",
            "description": "Additions or Changes in Entities, Jurisdictions or Subjects",
            "default": "update_report_request"
          },
          "id": {
            "type": "string",
            "format": "uuid",
            "example": "sdbgfxcs27477ad23fsas222d2223"
          },
          "params": {
            "$ref": "#/components/schemas/report_request_params_update_rr"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "approved",
              "rejected"
            ],
            "default": "pending"
          },
          "initiated_date": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "report_request_params_price": {
        "type": "object",
        "properties": {
          "concept": {
            "type": "string",
            "enum": [
              "Additional Research",
              "Record Retrieval",
              "Red Flag Checks",
              "Miscellaneous",
              "Deduction"
            ]
          },
          "unit_price": {
            "type": "number",
            "example": 150
          }
        }
      },
      "report_request_params_rush": {
        "type": "object",
        "properties": {
          "delivery_date": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "report_request_params_update_rr": {
        "type": "object",
        "properties": {
          "index": {
            "type": "number"
          },
          "item": {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string"
              },
              "rhs": {
                "type": "object",
                "properties": {
                  "option": {
                    "type": "object",
                    "properties": {
                      "key": {
                        "type": "string"
                      },
                      "name": {
                        "type": "string"
                      }
                    }
                  },
                  "value": {
                    "type": "object",
                    "properties": {
                      "iso2": {
                        "type": "string"
                      },
                      "iso3": {
                        "type": "string"
                      },
                      "name": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          },
          "kind": {
            "type": "string"
          },
          "path": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "estimates_response": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "example": "estimates"
              },
              "attributes": {
                "type": "object",
                "properties": {
                  "currency_code": {
                    "type": "string",
                    "example": "USD"
                  },
                  "delivery_date": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "order_detail": {
                    "type": "object",
                    "properties": {
                      "report_type": {
                        "type": "string",
                        "example": "level1"
                      },
                      "billing_account_id": {
                        "type": "string",
                        "example": "9PRO000200"
                      },
                      "base_report": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "type": "string",
                            "example": "DowJones report"
                          },
                          "unit_price": {
                            "type": "number",
                            "example": 1160
                          }
                        }
                      },
                      "additional_entities": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "string",
                              "example": "Additional entity"
                            },
                            "unit_price": {
                              "type": "number",
                              "example": 750
                            }
                          }
                        }
                      },
                      "additional_individuals": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "string",
                              "example": "Ivan Ivanov"
                            },
                            "unit_price": {
                              "type": "number",
                              "example": 750
                            }
                          }
                        }
                      },
                      "additional_jurisdictions": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "string",
                              "example": "Additional entity"
                            },
                            "unit_price": {
                              "type": "number",
                              "example": 600
                            }
                          }
                        }
                      },
                      "rush_charge": {
                        "type": "number",
                        "example": 1630
                      },
                      "total": {
                        "type": "number",
                        "example": 4890
                      },
                      "formatted": {
                        "type": "object",
                        "properties": {
                          "report_type": {
                            "type": "string",
                            "example": "level1"
                          },
                          "billing_account_id": {
                            "type": "string",
                            "example": "9PRO000200"
                          },
                          "base_report": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string",
                                "example": "DowJones report"
                              },
                              "unit_price": {
                                "type": "string",
                                "example": "$1,160.00"
                              }
                            }
                          },
                          "additional_entities": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "name": {
                                  "type": "string",
                                  "example": "Additional entity"
                                },
                                "unit_price": {
                                  "type": "string",
                                  "example": "$750.00"
                                }
                              }
                            }
                          },
                          "additional_individuals": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "name": {
                                  "type": "string",
                                  "example": "Ivan Ivanov"
                                },
                                "unit_price": {
                                  "type": "string",
                                  "example": "$750.00"
                                }
                              }
                            }
                          },
                          "additional_jurisdictions": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "name": {
                                  "type": "string",
                                  "example": "Additional entity"
                                },
                                "unit_price": {
                                  "type": "number",
                                  "example": "$600.00"
                                }
                              }
                            }
                          },
                          "rush_charge": {
                            "type": "number",
                            "example": "$1,630.00"
                          },
                          "total": {
                            "type": "number",
                            "example": "$4,890.00"
                          }
                        }
                      }
                    }
                  },
                  "total": {
                    "type": "number",
                    "example": 4890
                  }
                }
              },
              "links": {
                "type": "object",
                "properties": {
                  "self": {
                    "type": "string",
                    "format": "hostname",
                    "example": "https://api.dowjones.com/risk-reports/estimate"
                  },
                  "metadata": {
                    "type": "string",
                    "format": "hostname",
                    "example": "https://api.dowjones.com/risk-reports/metadata"
                  },
                  "reportRequests": {
                    "type": "string",
                    "format": "hostname",
                    "example": "https://api.dowjones.com/risk-reports/reportrequests"
                  }
                }
              }
            }
          }
        }
      },
      "report_request_estimate_request": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "$ref": "#/components/schemas/report_request_estimate_data_item"
          }
        },
        "required": [
          "data"
        ],
        "additionalProperties": false
      },
      "report_request_estimate_data_item": {
        "type": "object",
        "properties": {
          "attributes": {
            "type": "object",
            "$ref": "#/components/schemas/report_request_estimate_attributes"
          }
        },
        "required": [
          "attributes"
        ],
        "additionalProperties": false
      },
      "report_request_estimate_attributes": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 255,
            "example": "Dow Jones Report"
          },
          "report_type": {
            "type": "string"
          },
          "is_rush": {
            "type": "boolean"
          },
          "subject_type": {
            "type": "string",
            "enum": [
              "entity",
              "individual"
            ]
          },
          "subject": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "first_name": {
                    "type": "string",
                    "example": "John"
                  },
                  "middle_name": {
                    "type": "string",
                    "example": "Allan"
                  },
                  "last_name": {
                    "type": "string",
                    "example": "Doe"
                  },
                  "jurisdictions": {
                    "$ref": "#/components/schemas/report_request_individual_jurisdictions"
                  }
                }
              },
              {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "example": "Dow Jones"
                  },
                  "jurisdictions": {
                    "$ref": "#/components/schemas/report_request_entity_jurisdictions"
                  }
                }
              }
            ]
          },
          "additional_entities": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "example": "Dow Jones"
                },
                "jurisdictions": {
                  "$ref": "#/components/schemas/report_request_entity_jurisdictions"
                }
              }
            }
          },
          "additional_individuals": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "first_name": {
                  "type": "string",
                  "example": "John"
                },
                "middle_name": {
                  "type": "string",
                  "example": "Allan"
                },
                "last_name": {
                  "type": "string",
                  "example": "Doe"
                },
                "jurisdictions": {
                  "$ref": "#/components/schemas/report_request_individual_jurisdictions"
                }
              }
            }
          }
        }
      },
      "report_request_estimate_query_attributes": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 255,
            "example": "Dow Jones Report"
          },
          "report_type": {
            "type": "string"
          },
          "is_rush": {
            "type": "string"
          },
          "subject_type": {
            "type": "string",
            "enum": [
              "entity",
              "individual"
            ]
          },
          "subject": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "example": "Subject name"
                  },
                  "jurisdictions": {
                    "$ref": "#/components/schemas/report_request_entity_jurisdictions"
                  }
                }
              },
              {
                "type": "object",
                "properties": {
                  "first_name": {
                    "type": "string",
                    "example": "First name"
                  },
                  "middle_

# --- truncated at 32 KB (164 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dow-jones/refs/heads/main/openapi/dow-jones-due-diligence-reports-api-openapi.json