openapi.yaml

openapi: 3.0.2
info:
  description: Moov Watchman is an HTTP API and Go library to download, parse and offer search functions over numerous trade sanction lists from the United States, European Union governments, agencies, and non profits for complying with regional laws. Also included is a web UI and async webhook notification service to initiate processes on remote systems.
  version: v1
  title: Watchman API
  contact:
    url: https://github.com/moov-io/watchman
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html

servers:
  - url: http://localhost:8084
    description: Local development

tags:
  - name: Watchman
    description: Endpoints for searching individuals and corporations which US government enforces economic sanctions against and adding webhook notifications for search criteria.

paths:
  /ping:
    get:
      tags: ["Watchman"]
      summary: Ping the Watchman service to check if running
      operationId: ping
      responses:
        '200':
          description: Service is running properly

  # Company Endpoints
  /ofac/companies/{companyID}:
    get:
      tags: ["Watchman"]
      summary: Get information about a company, trust or organization such as addresses, alternate names, and remarks.
      operationId: getOfacCompany
      parameters:
        - name: X-Request-ID
          in: header
          description: Optional Request ID allows application developer to trace requests through the systems logs
          schema:
            type: string
            example: 94c825ee
        - name: X-User-ID
          in: header
          description: Optional User ID used to perform this search
          schema:
            type: string
        - name: companyID
          in: path
          description: Company ID
          required: true
          schema:
            type: string
            example: 1d1c824a
      responses:
        '200':
          description: Company and associated metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OfacCompany'
    put:
      tags: ["Watchman"]
      summary: Update a Companies sanction status to always block or always allow transactions.
      operationId: updateOfacCompanyStatus
      parameters:
        - name: X-Request-ID
          in: header
          description: Optional Request ID allows application developer to trace requests through the systems logs
          schema:
            type: string
            example: 94c825ee
        - name: X-User-ID
          in: header
          description: Optional User ID used to perform this search
          schema:
            type: string
        - name: companyID
          in: path
          description: Company ID
          required: true
          schema:
            type: string
            example: 8d49fd61
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOfacCompanyStatus'
      responses:
        '200':
          description: Company status updated
  /ofac/companies/{companyID}/watch:
    post:
      tags: ["Watchman"]
      summary: Add watch on a OFAC Company
      operationId: addOfacCompanyWatch
      parameters:
        - name: X-Request-ID
          in: header
          description: Optional Request ID allows application developer to trace requests through the systems logs
          schema:
            type: string
            example: 94c825ee
        - name: X-User-ID
          in: header
          description: Optional User ID used to perform this search
          schema:
            type: string
        - name: companyID
          in: path
          description: Company ID
          required: true
          schema:
            type: string
            example: c3cf0f66
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OfacWatchRequest'
      responses:
        '200':
          description: Company watch added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OfacWatch'
        '404':
          description: Company not found
  /ofac/companies/{companyID}/watch/{watchID}:
    delete:
      tags: ["Watchman"]
      summary: Remove company watch
      operationId: removeOfacCompanyWatch
      parameters:
        - name: X-Request-ID
          in: header
          description: Optional Request ID allows application developer to trace requests through the systems logs
          schema:
            type: string
            example: 94c825ee
        - name: X-User-ID
          in: header
          description: Optional User ID used to perform this search
          schema:
            type: string
        - name: companyID
          in: path
          description: Company ID
          required: true
          schema:
            type: string
            example: c3cf0f66
        - name: watchID
          in: path
          description: Watch ID, used to identify a specific watch
          required: true
          schema:
            type: string
            example: 0c5e215c
      responses:
        '200':
          description: Company watch removed
  /ofac/companies/watch:
    post:
      tags: ["Watchman"]
      summary: Add company watch by name. The match percentage will be included in the webhook's JSON payload.
      operationId: addOfacCompanyNameWatch
      parameters:
        - name: X-Request-ID
          in: header
          description: Optional Request ID allows application developer to trace requests through the systems logs
          schema:
            type: string
            example: 94c825ee
        - name: X-User-ID
          in: header
          description: Optional User ID used to perform this search
          schema:
            type: string
        - name: name
          in: query
          required: true
          description: Company name used to match and send watch notifications
          schema:
            type: string
            example: Jane Smith
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OfacWatchRequest'
      responses:
        '200':
          description: Company watch applied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OfacWatch'
  /ofac/companies/watch/{watchID}:
    delete:
      tags: ["Watchman"]
      summary: Remove a Company name watch
      operationId: removeOfacCompanyNameWatch
      parameters:
        - name: X-Request-ID
          in: header
          description: Optional Request ID allows application developer to trace requests through the systems logs
          schema:
            type: string
            example: 94c825ee
        - name: X-User-ID
          in: header
          description: Optional User ID used to perform this search
          schema:
            type: string
        - name: watchID
          in: path
          description: Watch ID, used to identify a specific watch
          required: true
          schema:
            type: string
            example: 0c5e215c
        - name: name
          in: query
          description: Company name watch
          required: true
          schema:
            type: string
            example: Jane Smith
      responses:
        '200':
          description: Company watch removed
  # Customer Endpoints
  /ofac/customers/{customerID}:
    get:
      tags: ["Watchman"]
      summary: Get information about a customer, addresses, alternate names, and their SDN metadata.
      operationId: getOfacCustomer
      parameters:
        - name: X-Request-ID
          in: header
          description: Optional Request ID allows application developer to trace requests through the systems logs
          schema:
            type: string
            example: 94c825ee
        - name: X-User-ID
          in: header
          description: Optional User ID used to perform this search
          schema:
            type: string
        - name: customerID
          in: path
          description: Customer ID
          required: true
          schema:
            type: string
            example: c3cf0f66
      responses:
        '200':
          description: Customer and associated metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OfacCustomer'
    put:
      tags: ["Watchman"]
      summary: Update a Customer's sanction status to always block or always allow transactions.
      operationId: updateOfacCustomerStatus
      parameters:
        - name: X-Request-ID
          in: header
          description: Optional Request ID allows application developer to trace requests through the systems logs
          schema:
            type: string
            example: 94c825ee
        - name: X-User-ID
          in: header
          description: Optional User ID used to perform this search
          schema:
            type: string
        - name: customerID
          in: path
          description: Customer ID
          required: true
          schema:
            type: string
            example: c3cf0f66
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOfacCustomerStatus'
      responses:
        '200':
          description: Customer status updated
  /ofac/customers/{customerID}/watch:
    post:
      tags: ["Watchman"]
      summary: Add watch on a OFAC Customer
      operationId: addOfacCustomerWatch
      parameters:
        - name: X-Request-ID
          in: header
          description: Optional Request ID allows application developer to trace requests through the systems logs
          schema:
            type: string
            example: 94c825ee
        - name: X-User-ID
          in: header
          description: Optional User ID used to perform this search
          schema:
            type: string
        - name: customerID
          in: path
          description: Customer ID
          required: true
          schema:
            type: string
            example: c3cf0f66
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OfacWatchRequest'
      responses:
        '200':
          description: Customer watch added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OfacWatch'
        '404':
          description: Customer not found
  /ofac/customers/{customerID}/watch/{watchID}:
    delete:
      tags: ["Watchman"]
      summary: Remove customer watch
      operationId: removeOfacCustomerWatch
      parameters:
        - name: X-Request-ID
          in: header
          description: Optional Request ID allows application developer to trace requests through the systems logs
          schema:
            type: string
            example: 94c825ee
        - name: X-User-ID
          in: header
          description: Optional User ID used to perform this search
          schema:
            type: string
        - name: customerID
          in: path
          description: Customer ID
          required: true
          schema:
            type: string
            example: c3cf0f66
        - name: watchID
          in: path
          description: Watch ID, used to identify a specific watch
          required: true
          schema:
            type: string
            example: 0c5e215c
      responses:
        '200':
          description: Customer watch removed
  /ofac/customers/watch:
    post:
      tags: ["Watchman"]
      summary: Add customer watch by name. The match percentage will be included in the webhook's JSON payload.
      operationId: addOfacCustomerNameWatch
      parameters:
        - name: X-Request-ID
          in: header
          description: Optional Request ID allows application developer to trace requests through the systems logs
          schema:
            type: string
            example: 94c825ee
        - name: X-User-ID
          in: header
          description: Optional User ID used to perform this search
          schema:
            type: string
        - name: name
          in: query
          required: true
          description: Individual name used to match and send watch notifications
          schema:
            type: string
            example: Jane Smith
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OfacWatchRequest'
      responses:
        '200':
          description: Customer watch applied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OfacWatch'
  /ofac/customers/watch/{watchID}:
    delete:
      tags: ["Watchman"]
      summary: Remove a Customer name watch
      operationId: removeOfacCustomerNameWatch
      parameters:
        - name: X-Request-ID
          in: header
          description: Optional Request ID allows application developer to trace requests through the systems logs
          schema:
            type: string
            example: 94c825ee
        - name: X-User-ID
          in: header
          description: Optional User ID used to perform this search
          schema:
            type: string
        - name: watchID
          in: path
          description: Watch ID, used to identify a specific watch
          required: true
          schema:
            type: string
            example: 0c5e215c
        - name: name
          in: query
          description: Customer or Company name watch
          required: true
          schema:
            type: string
            example: Jane Smith
      responses:
        '200':
          description: Company or Customer watch removed

  # SDN Endpoints
  /ofac/sdn/{sdnID}:
    get:
      tags: ["Watchman"]
      summary: Specially designated national
      operationId: getSDN
      parameters:
        - name: X-Request-ID
          in: header
          description: Optional Request ID allows application developer to trace requests through the systems logs
          schema:
            type: string
            example: 94c825ee
        - name: X-User-ID
          in: header
          description: Optional User ID used to perform this search
          schema:
            type: string
        - in: path
          name: sdnID
          required: true
          description: SDN ID
          schema:
            type: string
            example: 564dd7d1
      responses:
        '200':
          description: SDN metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OfacSDN'
  /ofac/sdn/{sdnID}/alts:
    get:
      tags: ["Watchman"]
      summary: Get alternate names for a given SDN
      operationId: getSDNAltNames
      parameters:
        - name: X-Request-ID
          in: header
          description: Optional Request ID allows application developer to trace requests through the systems logs
          schema:
            type: string
            example: 94c825ee
        - name: X-User-ID
          in: header
          description: Optional User ID used to perform this search
          schema:
            type: string
        - in: path
          name: sdnID
          description: SDN ID
          required: true
          schema:
            type: string
            example: 564dd7d1
      responses:
        '200':
          description: SDN alternate names
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OfacSDNAltNames'
  /ofac/sdn/{sdnID}/addresses:
    get:
      tags: ["Watchman"]
      summary: Get addresses for a given SDN
      operationId: getSDNAddresses
      parameters:
        - name: X-Request-ID
          in: header
          description: Optional Request ID allows application developer to trace requests through the systems logs
          schema:
            type: string
            example: 94c825ee
        - name: X-User-ID
          in: header
          description: Optional User ID used to perform this search
          schema:
            type: string
        - in: path
          name: sdnID
          description: SDN ID
          required: true
          schema:
            type: string
            example: 564dd7d1
      responses:
        '200':
          description: SDN addresses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OfacEntityAddresses'
  # Search Endpoint
  /search:
    get:
      tags: ["Watchman"]
      summary: Search SDN names and metadata
      operationId: search
      parameters:
        - name: X-Request-ID
          in: header
          description: Optional Request ID allows application developer to trace requests through the systems logs
          schema:
            type: string
            example: 94c825ee
        - name: X-User-ID
          in: header
          description: Optional User ID used to perform this search
          schema:
            type: string
        - name: q
          in: query
          schema:
            type: string
            example: John Doe
          description: Search across Name, Alt Names, and SDN Address fields for all available sanctions lists. Entries may be returned in all response sub-objects.
        - name: name
          in: query
          schema:
            type: string
            example: Jane Smith
          description: Name which could correspond to an entry on the SDN, Denied Persons, Sectoral Sanctions Identifications, or BIS Entity List sanctions lists.
        - name: address
          in: query
          schema:
            type: string
            example: 123 83rd Ave
          description: Phsical address which could correspond to a human on the SDN list. Only Address results will be returned.
        - name: city
          in: query
          schema:
            type: string
            example: USA
          description: City name as desginated by SDN guidelines. Only Address results will be returned.
        - name: state
          in: query
          schema:
            type: string
            example: USA
          description: State name as desginated by SDN guidelines. Only Address results will be returned.
        - name: providence
          in: query
          schema:
            type: string
            example: USA
          description: Providence name as desginated by SDN guidelines. Only Address results will be returned.
        - name: zip
          in: query
          schema:
            type: string
            example: USA
          description: Zip code as desginated by SDN guidelines. Only Address results will be returned.
        - name: country
          in: query
          schema:
            type: string
            example: USA
          description: Country name as desginated by SDN guidelines. Only Address results will be returned.
        - name: altName
          in: query
          schema:
            type: string
            example: Jane Smith
          description: Alternate name which could correspond to a human on the SDN list. Only Alt name results will be returned.
        - name: id
          in: query
          schema:
            type: string
            example: '10517860'
          description: ID value often found in remarks property of an SDN. Takes the form of 'No. NNNNN' as an alphanumeric value.
        - name: limit
          in: query
          schema:
            type: integer
            example: 25
          description: Maximum results returned by a search
        - name: sdnType
          in: query
          schema:
            type: string
            example: individual
          description: Optional filter to only return SDNs whose type case-insensitively matches.
        - name: program
          in: query
          schema:
            type: string
            example: SDGT
          description: Optional filter to only return SDNs whose program case-insensitively matches
      responses:
        '200':
          description: SDNs returned from a search
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Search'

  # Downloads endpoint
  /downloads:
    get:
      tags: ["Watchman"]
      summary: Return list of recent downloads of list data
      operationId: getLatestDownloads
      parameters:
        - name: X-Request-ID
          in: header
          description: Optional Request ID allows application developer to trace requests through the systems logs
          schema:
            type: string
            example: 94c825ee
        - name: X-User-ID
          in: header
          description: Optional User ID used to perform this search
          schema:
            type: string
        - name: limit
          in: query
          schema:
            type: integer
            example: 25
          description: Maximum results returned by a search
      responses:
        '200':
          description: Recent timestamps and counts of parsed objects
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Downloads'
  /ui/values/{key}:
    get:
      tags: ["Watchman"]
      summary: Return an ordered distinct list of keys for an SDN property.
      operationId: getUIValues
      parameters:
        - in: path
          name: key
          description: SDN property to lookup. Values are sdnType, ofacProgram
          required: true
          schema:
            type: string
            example: sdnType
        - name: limit
          in: query
          schema:
            type: integer
            example: 25
          description: Maximum results returned by a search
      responses:
        '200':
          description: Ordered and distinct list of values for an SDN property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UIKeys'
        '400':
          description: Invalid key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'

components:
  schemas:
    Error:
      required:
        - error
      properties:
        error:
          type: string
          description: An error message describing the problem intended for humans.
          example: Unknown key
    OfacCompany:
      description: OFAC Company and metadata
      properties:
        ID:
          description: OFAC Company ID
          type: string
          example: 9574756b
        sdn:
          $ref: '#/components/schemas/OfacSDN'
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/OfacEntityAddress'
        alts:
          type: array
          items:
            $ref: '#/components/schemas/OfacAlt'
        status:
          $ref: '#/components/schemas/OfacCompanyStatus'
    OfacCompanyStatus:
      description: Status properties of an OFAC Company
      properties:
        userID:
          description: User ID provided when updating status
          type: string
          example: 349661f9
        note:
          description: Optional note from updating status
          type: string
          example: 'Incorrect match'
        status:
          description: Manually applied status for OFAC Company
          type: string
          enum:
            - unsafe
            - exception
        createdAt:
          type: string
          format: date-time
          example: 2006-01-02T15:04:05Z07:00
    OfacCustomer:
      description: OFAC Customer and metadata
      properties:
        ID:
          description: OFAC Customer ID
          type: string
          example: 9574756b
        sdn:
          $ref: '#/components/schemas/OfacSDN'
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/OfacEntityAddress'
        alts:
          type: array
          items:
            $ref: '#/components/schemas/OfacAlt'
        status:
          $ref: '#/components/schemas/OfacCustomerStatus'
    OfacCustomerStatus:
      description: Status properties of an OFAC Customer
      properties:
        userID:
          description: User ID provided when updating status
          type: string
          example: 349661f9
        note:
          description: Optional note from updating status
          type: string
          example: 'Incorrect match'
        status:
          description: Manually applied status for OFAC Customer
          type: string
          enum:
            - unsafe
            - exception
        createdAt:
          type: string
          format: date-time
          example: 2006-01-02T15:04:05Z07:00
    OfacSDN:
      description: Specially designated national from OFAC list
      properties:
        entityID:
          type: string
          example: 1231
        sdnName:
          type: string
          example: BANCO NACIONAL DE CUBA
        sdnType:
          description: SDN's typically represent an individual (customer) or trust/company/organization. OFAC endpoints refer to customers or companies as different entities, but underlying both is the same SDN metadata.
          type: string
          example: individual
        programs:
          type: array
          items:
            type: string
          description: Programs is the sanction programs this SDN was added from
          example: [CUBA]
        title:
          type: string
          example: Title of an individual
        remarks:
          type: string
        match:
          type: number
          example: 0.91
          description: Remarks on SDN and often additional information about the SDN
    OfacEntityAddresses:
      type: array
      items:
        $ref: '#/components/schemas/OfacEntityAddress'
    OfacEntityAddress:
      description: Physical address from OFAC list
      properties:
        entityID:
          type: string
          example: 2112
        addressID:
          type: string
          example: 201
        address:
          type: string
          example: 123 73th St
        cityStateProvincePostalCode:
          type: string
          example: Tokyo 103
        country:
          type: string
          example: Japan
        match:
          type: number
          example: 0.91
    OfacSDNAltNames:
      type: array
      items:
        $ref: '#/components/schemas/OfacAlt'
    OfacAlt:
      description: Alternate name from OFAC list
      properties:
        entityID:
          type: string
          example: 306
        alternateID:
          type: string
          example: 220
        alternateType:
          type: string
          example: aka
        alternateName:
          type: string
          example: NATIONAL BANK OF CUBA
        alternateRemarks:
          type: string
          example: Extra information
        match:
          type: number
          example: 0.91
    DPL:
      description: BIS Denied Persons List item
      properties:
        name:
          type: string
          description: Name of the Denied Person
          example: ISMAEL RETA
        streetAddress:
          type: string
          description: "Denied Person's street address"
          example: 'REGISTER NUMBER: 78795-379, FEDERAL CORRECTIONAL INSTITUTION, P.O. BOX 4200'
        city:
          type: string
          description: "Denied Person's city"
          example: THREE RIVERS
        state:
          type: string
          description: "Denied Person's state"
          example: TX
        country:
          type: string
          description: "Denied Person's country"
          example: ""
        postalCode:
          type: string
          description: "Denied Person's postal code"
          example: 78071
        effectiveDate:
          type: string
          description: Date when denial came into effect
          example: '06/15/2016'
        expirationDate:
          type: string
          description: Date when denial expires, if blank denial never expires
          example: '06/15/2025'
        standardOrder:
          type: string
          description: Denotes whether or not the Denied Person was added by a standard order
          example: 'Y'
        lastUpdate:
          type: string
          description: Most recent date when the Denied Person record was updated
          example: '2016-06-22'
        action:
          type: string
          description: Most recent action taken regarding the denial
          example: FR NOTICE ADDED
        frCitation:
          type: string
          description: Reference to the order's citation in the Federal Register
          example: '81.F.R. 40658 6/22/2016'
        match:
          type: number
          example: 0.92
    SSI:
      description: Treasury Department Sectoral Sanctions Identifications List (SSI)
      properties:
        entityID:
          type: string
          description: The ID assigned to an entity by the Treasury Department
          example: 1231
        type:
          type: string
          description: Entity type (e.g. individual, vessel, aircraft, etc)
          example: individual
        programs:
          type: array
          items:
            type: string
          description: Sanction programs for which the entity is flagged
          example: ["UKRAINE-EO13662", "SYRIA"]
        name:
          type: string
          description: The name of the entity
          example: PJSC VERKHNECHONSKNEFTEGAZ
        addresses:
          type: array
          items:
            type: string
          description: Addresses associated with the entity
          example: ["D. Retyum, Luzhski Raion, Leningradskaya Obl., 188230, RU", "Retiun Village, Lujskiy District, Leningrad Region, RU"]
        remarks:
          type: array
          items:
            type: string
          description: Additional details regarding the entity
          example: ["For more information on directives, please visit the following link: http://www.treasury.gov/resource-center/sanctions/Programs/Pages/ukraine.aspx#directives.", "(Linked To: OPEN JOINT-STOCK COMPANY ROSNEFT OIL COMPANY)"]
        alternateNames:
          type: array
          items:
            type: string
          description: Known aliases associated with the entity
          example: ["VERKHNECHONSKNEFTEGAZ", "OJSC VERKHNECHONSKNEFTEGAZ"]
        ids:
          type: array
          items:
            type: string
          description: IDs on file for the entity
          example: ["Subject to Directive 4, Executive Order 13662 Directive Determination", "vcng@rosneft.ru, Email Address", "Subject to Directive 2, Executive Order 13662 Directive Determination"]
        sourceListURL:
          type: string
          description: The link to the official SSI list
          example: http://bit.ly/1MLgou0
        sourceInfoURL:
          type: string
          description: The link for information regarding the source
          example: http://bit.ly/1MLgou0
    BISEntities:
      description: Bureau of Industry and Security Entity List
      properties:
        name:
          type: string
          description: The name of the entity
          example: Luhansk People’s Republic
        addresses:
          type: array
          items:
            type: string
          description: Addresses associated with the entity
          example: ["D. Retyum, Luzhski Raion, Leningradskaya Obl., 188230, RU", "Retiun Village, Lujskiy District, Leningrad Region, RU"]
        alternateNames:
          type: array
          items:
            type: string
          description: Known aliases associated with the entity
          example: ["VERKHNECHONSKNEFTEGAZ", "OJSC VERKHNECHONSKNEFTEGAZ"]
        startDate:
          type: string
          description: Date when the restriction came into effect
          example: 6/21/16
        licenseRequirement:
          type: string
          description: Specifies the license requirement imposed on the named entity
          example: "For all items subject to the EAR. (See §744.11 of the EAR)."
        licensePolicy:
          type: string
          description: Identifies the policy BIS uses to review the licenseRequirements
          example: "Presumption of denial."
        frNotice:
          type: string
          description: Identifies the corresponding Notice in the Federal Register
          example: 81 FR 61595
        sourceListURL:
          type: string
          description: The link to the official SSI list
          example: http://bit.ly/1MLgou0
        sourceInfoURL:
          type: string
          description: The link for information regarding the source
          example: http://bit.ly/1MLgou0
    UpdateOfacCompanyStatus:
      description: Request body to update a company status.
      properties:
        status:
          description: manual override of company/SDN sanction status
          type: string
          enum:
            - unsafe
            - exception
        notes:
          description: Free form notes about manually changing the Company status
          type: string
          example: "False positive"
      required:
        - status
    UpdateOfacCustomerStatus:
      description: Request body to update a customers status.
      properties:
        status:
          description: manual override of customer/SDN sanction status
          type: string
          enum:
            - unsafe
            - exception
        notes:
          description: Free form notes about manually changing the Customer status
          type: string
          example: "False positive"
      required:
        - status
    Search:
      description: Search results containing SDNs, alternate names and/or addreses
      properties:
        # OFAC
        SDNs:
          type: array
          items:
            $ref: '#/components/schemas/OfacSDN'
        altNames:
          type: array
          items:
            $ref: '#/components/schemas/OfacAlt'
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/OfacEntityAddress'
        sectoralSanctions:
          type: array
          items:
            $ref: '#/components/schemas/SSI'
        # BIS
        deniedPersons:
          type: array
          items:
            $ref: '#/components/schemas/DPL'
        bisEntities:
          type: array
          items:
            $ref: '#/components/schemas/BISEntities'
        # Metadata
        refreshedAt:
          type: string
          format: date-time
          example: 2006-01-02T15:04:05Z07:00
    OfacWatch:
      description: Customer or Company watch
      properties:
        watchID:
          description: Object representing a customer or company watch
          type: string
          example: 08ddba92
    OfacWatchRequest:
      description: Webhook or other means of notification on search criteria. OFAC will make a POST request with a body of the customer or company (SDN, AltNames, and Address).
      properties:
        authToken:
          description: Private token supplied by clients to be used for authenticating webhooks.
          type: string
          example: 75d0384b-a105-4048-9fce-91a280ce7337
        webhook:
          description: HTTPS url for webhook on search match
          type: string
          example: https://api.example.com/ofac/webhook
      required:
        - authToken
        - webhook
    Downloads:
      type: array
      items:
        $ref: '#/components/schemas/Download'
    Download:
      description: Metadata and stats about downloaded OFAC data
      properties:
        # OFAC
        SDNs:
          type: integer
          example: 7414
        altNames:
          type: integer
          example: 9729
        addresses:
          type: integer
          example: 11747
        sectoralSanctions:
          type: integer
          example: 329
        # BIS
        deniedPersons:
          type: integer
          example: 842
        bisEntities:
          type: integer
          example: 1391
        # Metadata
        timestamp:
          type: string
          format: date-time
          example: 2006-01-02T15:04:05Z07:00
    UIKeys:
      type: array
      items:
        type: string
        example: ["entity", "aircraft", "individual", "vessel"]