Dow Jones Risk Reports API

openapi: 3.2.0
info:
  title: Risk & Compliance Risk Reports API
  version: 1.18.11
  description: API
servers:
- url: https://api.dowjones.com/risk-reports
tags:
- name: Risk Reports
  description: API
paths:
  /billing-accounts:
    get:
      summary: Get a list of the billing accounts and their report types
      operationId: getBillingAccounts
      tags:
      - Risk Reports
      security:
      - OrderTool: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_billingaccounts_response'
            application/vnd.dowjones.dna.metadata.v_1.0_beta+json:
              schema:
                $ref: '#/components/schemas/get_billingaccounts_response'
  /reportrequests/{reportRequestId}/comments:
    get:
      summary: Get comments by report request id
      description: Get a list of all comments for specified report request ID
      operationId: getReportRequestComments
      tags:
      - Risk Reports
      security:
      - OrderTool: []
      parameters:
      - name: reportRequestId
        in: path
        schema:
          type: string
        required: true
        description: The unique identifier of the report request
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/comment_response'
            application/vnd.dowjones.dna.reportrequests.v_1.0_beta+json:
              schema:
                $ref: '#/components/schemas/comment_response'
        '404':
          description: report request with the given ID not found or user billing account doesn't match with billing account of report request
    post:
      summary: Create a new comment
      description: Create a new comment request for the given Report Request ID
      operationId: createReportRequestComment
      tags:
      - Risk Reports
      security:
      - OrderTool: []
      parameters:
      - name: reportRequestId
        in: path
        schema:
          type: string
        required: true
        description: The unique identifier of the report request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/comment_create'
          application/vnd.dowjones.dna.reportrequests.v_1.0_beta+json:
            schema:
              $ref: '#/components/schemas/comment_create'
      responses:
        '201':
          description: created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/create_comment_response'
            application/vnd.dowjones.dna.reportrequests.v_1.0_beta+json:
              schema:
                $ref: '#/components/schemas/create_comment_response'
        '404':
          description: report request with the given ID not found or user billing account doesn't match with billing account of report request
  /reportrequests/{reportRequestId}/comments/{commentId}:
    get:
      summary: Get comments by report and comment id
      description: Get a list of all comments for specified report request ID
      operationId: getCommentsbyId
      tags:
      - Risk Reports
      security:
      - OrderTool: []
      parameters:
      - name: reportRequestId
        in: path
        schema:
          type: string
        required: true
        description: The unique identifier of the report request
      - name: commentId
        in: path
        schema:
          type: string
        required: true
        description: The unique identifier of the comment
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/comment_response'
            application/vnd.dowjones.dna.reportrequests.v_1.0_beta+json:
              schema:
                $ref: '#/components/schemas/comment_response'
        '404':
          description: commentId with the given ID not found or user billing account doesn't match with billing account of report request
  /reportrequests/{reportRequestId}/documents:
    get:
      summary: Get all documents by report request id
      description: Get all documents by report request id
      operationId: getReportRequestDocuments
      security:
      - OrderTool: []
      tags:
      - Risk Reports
      parameters:
      - name: reportRequestId
        in: path
        schema:
          type: string
        required: true
        description: The unique identifier of the report request
      responses:
        '200':
          description: requested documents
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documents_response'
            application/x-www-form-urlencoded:
              schema:
                $ref: '#/components/schemas/documents_response'
          links:
            getReportRequestDocumentById:
              operationId: getReportRequestDocumentById
              parameters:
                additionalPriceProposalId: $response.body#/data/attributes/documents/#/0/id
              description: 'The `id` value returned in the response can be used as the `documentId` parameter in `GET /reportrequests/{reportRequestId}/documents/{documentId}`.

                '
        '404':
          description: bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request_error_response'
    post:
      summary: Add a support document by report request id
      description: Receives document files and upload to s3
      tags:
      - Risk Reports
      security:
      - OrderTool: []
      parameters:
      - name: reportRequestId
        in: path
        schema:
          type: string
        required: true
        description: The unique identifier of the report request
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
      responses:
        '201':
          description: The uploaded document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/document'
        '404':
          description: A report request was not found with the given ID
  /reportrequests/{reportRequestId}/documents/{documentId}:
    get:
      summary: Get document by report request and document id
      description: Get document by id
      operationId: getReportRequestDocumentById
      security:
      - OrderTool: []
      tags:
      - Risk Reports
      parameters:
      - name: reportRequestId
        in: path
        schema:
          type: string
        required: true
        description: The unique identifier of the report request
      - name: documentId
        in: path
        schema:
          type: string
        required: true
        description: The unique identifier of the document
      responses:
        '200':
          description: requested document
          content:
            text/plain:
              schema:
                type: string
                format: binary
            application/vnd.ms-excel:
              schema:
                type: string
                format: binary
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                type: string
                format: binary
        '404':
          description: not found
  /estimate:
    post:
      summary: Send a report request to receive a price estimate
      description: Gets an estimate for a pending report request
      operationId: postEstimate
      security:
      - OrderTool: []
      tags:
      - Risk Reports
      parameters:
      - name: account_id
        in: query
        schema:
          type: string
        required: false
        description: Account ID of the user that performed the transaction
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/report_request_estimate_request'
          application/vnd.dowjones.dna.reportrequests.v_1.0_beta+json:
            schema:
              $ref: '#/components/schemas/report_request_estimate_request'
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/estimates_response'
        '400':
          description: bad request body
        '404':
          description: the billing account hasn't been found
  /metadata:
    get:
      summary: Get data used to create report requests
      operationId: getMetadata
      tags:
      - Risk Reports
      security:
      - OrderTool: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/metadata_response'
            application/vnd.dowjones.dna.metadata.v_1.0_beta+json:
              schema:
                $ref: '#/components/schemas/metadata_response'
        '400':
          description: Billing account id not found in the request body
        '401':
          description: You do not have the correct authorization to access this resource.
        '404':
          description: Billing account with the given ID not found
    patch:
      summary: Update URL used for callback notification
      description: Update the data related to report requests and required for its creation
      operationId: patchMetadata
      security:
      - OrderTool: []
      tags:
      - Risk Reports
      parameters:
      - name: account_id
        in: query
        schema:
          type: string
        required: false
        description: Account ID of the user that performed the transaction
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/metadata_patch_request'
          application/vnd.dowjones.dna.reportrequests.v_1.0_beta+json:
            schema:
              $ref: '#/components/schemas/metadata_patch_request'
      responses:
        '202':
          description: success
        '400':
          description: bad request body
        '403':
          description: The service behind the callback url isn't accessible (https POST request, 200 response status code expected)
        '404':
          description: the billing account hasn't been found
  /reportrequests/{reportRequestId}/proposals:
    parameters:
    - name: reportRequestId
      in: path
      schema:
        type: string
      required: true
      description: The unique identifier of the report request
    get:
      summary: Get outstanding proposals by report request id
      description: Get proposals for a report request.
      security:
      - OrderTool: []
      tags:
      - Risk Reports
      responses:
        '200':
          description: The report request proposals
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/proposals_response'
        '404':
          description: A report request with the ID provided was not found
        '500':
          description: Internal Server Error
  /reportrequests/{reportRequestId}/proposals/{proposalId}:
    get:
      summary: Get a proposal by report request and proposal id
      description: Gets a proposal.
      security:
      - OrderTool: []
      tags:
      - Risk Reports
      parameters:
      - name: reportRequestId
        in: path
        schema:
          type: string
        required: true
        description: The unique identifier of the report request
      - name: proposalId
        in: path
        schema:
          type: string
        required: true
        description: The unique identifier of the proposal
      responses:
        '200':
          description: The report request proposal
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/proposal_response'
        '404':
          description: A report request or proposal with the ID was not found.
        '500':
          description: Internal Server Error
  /reportrequests/{reportRequestId}/proposals/{proposalType}/{additionalPriceProposalId}:
    patch:
      summary: Approve proposal by report request id and proposal type
      description: Approve proposal
      operationId: approveReportRequestProposal
      security:
      - OrderTool: []
      tags:
      - Risk Reports
      parameters:
      - name: reportRequestId
        in: path
        schema:
          type: string
        required: true
        description: The unique identifier of the report request
      - name: proposalType
        in: path
        schema:
          type: string
          enum:
          - rush
          - update_report_request
          - additional_price
        required: true
        description: The unique identifier of the proposal
      - name: additionalPriceProposalId
        required: true
        in: path
        schema:
          type: string
        description: The unique identifier of the additional price proposal
      responses:
        '204':
          description: success
        '404':
          description: proposal not found
        '409':
          description: already approved/rejected
    delete:
      summary: Reject proposal by report request id and proposal type
      description: Reject proposal
      operationId: rejectReportRequestProposal
      security:
      - OrderTool: []
      tags:
      - Risk Reports
      parameters:
      - name: reportRequestId
        in: path
        schema:
          type: string
        required: true
        description: The unique identifier of the report request
      - name: proposalType
        in: path
        schema:
          type: string
          enum:
          - rush
          - update_report_request
          - additional_price
        required: true
        description: The unique identifier of the proposal
      - name: additionalPriceProposalId
        in: path
        required: true
        schema:
          type: string
        description: The unique identifier of the additional price proposal
      responses:
        '204':
          description: success
        '404':
          description: proposal not found
        '409':
          description: already approved/rejected
  /reportrequests/{reportRequestId}/subscribe:
    post:
      operationId: subscribeOnReportRequestByID
      summary: Subscribe to events related to a report request by id
      security:
      - OrderTool: []
      tags:
      - Risk Reports
      parameters:
      - name: reportRequestId
        in: path
        required: true
        description: The unique identifier of the report request
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/subscribe_request'
      callbacks:
        event:
          '{$metadata#/callback_url}':
            post:
              responses:
                '200':
                  description: Your server returns this code if it accepts the callback
              requestBody:
                content:
                  application/json:
                    schema:
                      oneOf:
                      - $ref: '#/components/schemas/comment_delete_callback'
                      - $ref: '#/components/schemas/comment_update_callback'
                      - $ref: '#/components/schemas/comment_reply_callback'
                      - $ref: '#/components/schemas/comment_new_callback'
                      - $ref: '#/components/schemas/reportrequest_transition_callback'
                      - $ref: '#/components/schemas/reportrequest_update_callback'
                      - $ref: '#/components/schemas/document_new_callback'
                      - $ref: '#/components/schemas/document_update_callback'
                      - $ref: '#/components/schemas/document_delete_callback'
                      - $ref: '#/components/schemas/proposal_new_callback'
                      - $ref: '#/components/schemas/proposal_approval_callback'
                      - $ref: '#/components/schemas/proposal_update_callback'
                      - $ref: '#/components/schemas/proposal_reject_callback'
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subscribe_response'
            application/vnd.dowjones.dna.reportrequests.v_1.0_beta+json:
              schema:
                $ref: '#/components/schemas/subscribe_response'
        '404':
          description: not found
  /reportrequests/{reportRequestId}/unsubscribe:
    post:
      operationId: unsubscribeFromReportRequestById
      summary: Unsubscribe to events related to a report request by id
      security:
      - OrderTool: []
      tags:
      - Risk Reports
      parameters:
      - name: reportRequestId
        in: path
        required: true
        description: The unique identifier of the report request
        schema:
          type: string
      responses:
        '200':
          description: success
        '404':
          description: not found
  /reportrequests/{reportRequestId}:
    get:
      operationId: getReportRequestById
      summary: Get a report request by id
      security:
      - OrderTool: []
      tags:
      - Risk Reports
      parameters:
      - name: reportRequestId
        in: path
        required: true
        description: The unique identifier of the report request
        schema:
          type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                oneOf:
                - $ref: '#/components/schemas/report_request_response_individual'
                - $ref: '#/components/schemas/report_request_response_entity'
            application/vnd.dowjones.dna.reportrequests.v_1.0_beta+json:
              schema:
                type: object
                oneOf:
                - $ref: '#/components/schemas/report_request_response_individual'
                - $ref: '#/components/schemas/report_request_response_entity'
          links:
            approveReportRequestProposal:
              operationId: approveReportRequestProposal
              parameters:
                additionalPriceProposalId: $response.body#/data/attributes/proposals/#/0/id
              description: 'The `id` value in price proposals returned in the response can be used as the `additionalPriceProposalId` parameter in `PATCH /reportrequests/{reportRequestId}/proposals`.

                '
            rejectReportRequestProposal:
              operationId: rejectReportRequestProposal
              parameters:
                additionalPriceProposalId: $response.body#/data/attributes/proposals/#/0/id
              description: 'The `id` value in price proposals returned in the response can be used as the `additionalPriceProposalId` parameter in `DELETE /reportrequests/{reportRequestId}/proposals`.

                '
        '404':
          description: not found
  /reportrequests:
    post:
      summary: Create a new Enhanced Due Diligence report request
      operationId: createReportRequest
      tags:
      - Risk Reports
      security:
      - OrderTool: []
      parameters:
      - name: account_id
        in: query
        schema:
          type: string
        required: false
        description: Account ID of the user that performed the transaction
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/report_request_create_request_individual'
              - $ref: '#/components/schemas/report_request_create_request_entity'
          application/vnd.dowjones.dna.reportrequests.v_1.0_beta+json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/report_request_create_request_individual'
              - $ref: '#/components/schemas/report_request_create_request_entity'
      responses:
        '201':
          description: created
          content:
            application/json:
              schema:
                type: object
                oneOf:
                - $ref: '#/components/schemas/report_request_response_individual'
                - $ref: '#/components/schemas/report_request_response_entity'
            application/vnd.dowjones.dna.reportrequests.v_1.0_beta+json:
              schema:
                type: object
                oneOf:
                - $ref: '#/components/schemas/report_request_response_individual'
                - $ref: '#/components/schemas/report_request_response_entity'
          links:
            getReportRequestById:
              operationId: getReportRequestById
              parameters:
                reportRequestId: $response.body#/data/id
              description: The `id` value returned in the response can be used as the `reportRequestId` parameter in `GET /reportrequests/{reportRequestId}`.
            getReportRequestDocuments:
              operationId: getReportRequestDocuments
              parameters:
                reportRequestId: $response.body#/data/id
              description: The `id` value returned in the response can be used as the `reportRequestId` parameter in `GET /reportrequests/{reportRequestId}/documents`.
            getReportRequestComments:
              operationId: getReportRequestComments
              parameters:
                reportRequestId: $response.body#/data/id
              description: The `id` value returned in the response can be used as the `reportRequestId` parameter in `GET /reportrequests/{reportRequestId}/comments`.
            createReportRequestComment:
              operationId: createReportRequestComment
              parameters:
                reportRequestId: $response.body#/data/id
              description: The `id` value returned in the response can be used as the `reportRequestId` parameter in `POST /reportrequests/{reportRequestId}/comments`.
            approveReportRequestProposal:
              operationId: approveReportRequestProposal
              parameters:
                reportRequestId: $response.body#/data/id
                additionalPriceProposalId: $response.body#/data/attributes/proposals/#/0/id
              description: 'The `id` value returned in the response can be used as the `reportRequestId` parameter in `PATCH /reportrequests/{reportRequestId}/proposals`. The `id` value in price proposals returned in the response can be used as the `additionalPriceProposalId` parameter.

                '
            rejectReportRequestProposal:
              operationId: rejectReportRequestProposal
              parameters:
                reportRequestId: $response.body#/data/id
                additionalPriceProposalId: $response.body#/data/attributes/proposals/#/0/id
              description: 'The `id` value returned in the response can be used as the `reportRequestId` parameter in `DELETE /reportrequests/{reportRequestId}/proposals`. The `id` value in price proposals returned in the response can be used as the `additionalPriceProposalId` parameter.

                '
        '400':
          description: bad request body
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request_error_response'
            application/vnd.dowjones.dna.reportrequests.v_1.0_beta+json:
              schema:
                $ref: '#/components/schemas/bad_request_error_response'
    get:
      operationId: getReportRequests
      summary: Get all report requests
      security:
      - OrderTool: []
      tags:
      - Risk Reports
      parameters:
      - name: filter[cilent_reference][eq]
        in: query
        schema:
          type: string
        required: false
        description: The client reference of the report
      - name: filter[report_type][eq]
        in: query
        schema:
          type: string
          enum:
          - redflag
          - custom
          - level1
        required: false
        description: The type of report
      - name: filter[workflow_state.value][in]
        in: query
        schema:
          type: array
          items:
            type: string
            enum:
            - new
            - draft
            - pending_customer_approval
            - delivered
            - submitted
            - in_progress
            - completed
            default: submitted
        required: false
        description: Filter on workflow_state
      - name: filter[expected_delivery_beginning_date][lt]
        in: query
        schema:
          type: string
          format: date
        required: false
        description: will filter the report requests that have the delivered date in the string provided (ISO8601)
      - name: filter[expected_delivery_end_date][gt]
        in: query
        schema:
          type: string
          format: date
        required: false
        description: will filter the report requests based on the expected delivery date (ISO8601)
      - name: search
        in: query
        schema:
          type: string
        required: false
        description: Used the same way as filter[][] but returns all report requests matching at least one of the search criteria.  Most efficient when combined with filter.  All filter queries are supported as search queries.
      - name: page[size]
        in: query
        schema:
          type: integer
          default: 100
        required: false
        description: The amount of report requests to return up to 100.
      - name: page[number]
        in: query
        schema:
          type: integer
          default: 1
        required: false
        description: The page to retrieve of report requests.
      - name: count
        in: query
        schema:
          type: boolean
          default: false
        required: false
        description: Retrieve just the count of the filtered set
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/report_requests_response'
            application/vnd.dowjones.dna.reportrequests.v_1.0_beta+json:
              schema:
                type: object
                $ref: '#/components/schemas/report_requests_response'
          links:
            approveReportRequestProposal:
              operationId: approveReportRequestProposal
              parameters:
                additionalPriceProposalId: $response.body#/data/attributes/proposals/#/0/id
              description: 'The `id` value in price proposals returned in the response can be used as the `additionalPriceProposalId` parameter in `PATCH /reportrequests/{reportRequestId}/proposals`.

                '
            rejectReportRequestProposal:
              operationId: rejectReportRequestProposal
              parameters:
                additionalPriceProposalId: $response.body#/data/attributes/proposals/#/0/id
              description: 'The `id` value in price proposals returned in the response can be used as the `additionalPriceProposalId` parameter in `DELETE /reportrequests/{reportRequestId}/proposals`.

                '
        '401':
          description: You do not have the correct authorization to access this resource.
        '404':
          description: not found
components:
  schemas:
    report_request_entity_address:
      type: object
      properties:
        line1:
          type: string
          example: 123 Paper Street
        city:
          type: string
          example: Miami
        postal_code:
          type: string
          example: '55555'
        country:
          type: string
          example: United States
        state:
          type: string
          example: Florida
        email:
          type: string
          format: email
          example: john.doe@example.com
        phone_number:
          type: string
          example: 555-555-5555
        company_url:
          type: string
          format: hostname
      required:
      - country
    report_request_estimate_request:
      type: object
      properties:
        data:
          type: object
          $ref: '#/components/schemas/report_request_estimate_data_item'
      required:
      - data
      additionalProperties: false
    report_request_individual_address:
      type: object
      properties:
        line1:
          type: string
          example: 123 Paper Street
        city:
          type: string
          example: Miami
        postal_code:
          type: string
          example: '55555'
        country:
          type: string
          example: United States
        state:
          type: string
          example: Florida
      required:
      - country
      additionalProperties: false
    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
    subscription_data_item:
      type: object
      properties:
        type:
          type: string
          example: subscriptions
        id:
          type: string
          example: c2be7b6ca73747faadd4420123db424a
        attributes:
          type: object
          $ref: '#/components/schemas/subscribe_attributes'
        links:
          type: object
          properties:
            subscribe:
              type: string
              format: hostname
              example: https://api.dowjones.com/risk-reports/reportrequests/d5ee7ceb98a848a49420d7cce2601934/subscribe
            unsubscribe:
              type: string
              format: hostname
              example: https://api.dowjones.com/risk-reports/reportrequests/d5ee7ceb98a848a49420d7cce2601934/unsubscribe
    subscribe_data_item:
      type: object
      properties:
        type:
          type: string
          example: subscriptions
        id:
          type: string
          example: b5948eb9f7474aa8a0148b7be9b66e60
        links:
          type: object
          properties:
            self:
              type: string
              format: hostname
              example: https://api.dowjones.com/risk-reports/reportrequests/d5ee7ceb98a848a49420d7cce2601934/subscriptions/b5948eb9f7474aa8a0148b7be9b66e60
        attributes:
          type: object
          $ref: '#/components/schemas/subscribe_attributes'
      required:
      - attributes
    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
    report_request_create_attributes_individual:
      type: object
      properties:
        name:
          type: string
          maxLength: 255
          example: Dow Jones Report
        report_type:
          type: string
        subscription_on:
          type: boolean
        subscription_id:
          type: string
          format: uuid
          maxLength: 255
        workflow_state:
          type: string
          enum:
          - draft
          - submitted
        subject_type:
          type: string
          enum:
          - entity
          - individual
        subject:
          $ref: '#/compone

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