arazzo: 1.0.1
info:
  title: D&B Match And Audit History
  summary: Resolve a candidate to a D-U-N-S Number, then retrieve a historical Direct+ response for audit and reconciliation.
  description: >-
    A research and reconciliation flow. The workflow resolves a candidate
    record to a D-U-N-S Number with cleanseMatch, then retrieves a historical
    Direct+ response previously returned for that D-U-N-S Number at a supplied
    transaction timestamp, supporting audit and dispute use cases. Each step
    spells out its request inline so the flow can be read and executed without
    opening the underlying OpenAPI description.
  version: 1.0.0
sourceDescriptions:
- name: dnbDirectPlusApi
  url: ../openapi/dnb-direct-plus-openapi-original.yml
  type: openapi
workflows:
- workflowId: match-and-audit-history
  summary: Match a candidate, then pull a historical audit record for the D-U-N-S Number.
  description: >-
    Resolves a candidate to its top D-U-N-S Number, then retrieves the
    historical Direct+ response for that D-U-N-S Number at the supplied
    transaction timestamp.
  inputs:
    type: object
    required:
    - accessToken
    - name
    - countryISOAlpha2Code
    - transactionTimestamp
    properties:
      accessToken:
        type: string
        description: A valid Direct+ OAuth 2.0 bearer access token.
      name:
        type: string
        description: Business name to resolve.
      countryISOAlpha2Code:
        type: string
        description: ISO 3166-1 alpha-2 country code of the candidate.
      transactionTimestamp:
        type: string
        description: ISO 8601 timestamp of the historical transaction to retrieve.
  steps:
  - stepId: matchCompany
    description: >-
      Resolve the candidate record to ranked D-U-N-S match candidates.
    operationId: cleanseMatch
    parameters:
    - name: Authorization
      in: header
      value: Bearer $inputs.accessToken
    - name: name
      in: query
      value: $inputs.name
    - name: countryISOAlpha2Code
      in: query
      value: $inputs.countryISOAlpha2Code
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      topDuns: $response.body#/matchCandidates/0/organization/duns
  - stepId: getAuditRecord
    description: >-
      Retrieve the historical Direct+ response previously returned for the
      resolved D-U-N-S Number at the supplied transaction timestamp.
    operationId: getAuditRecord
    parameters:
    - name: Authorization
      in: header
      value: Bearer $inputs.accessToken
    - name: duns
      in: path
      value: $steps.matchCompany.outputs.topDuns
    - name: transactionTimestamp
      in: query
      value: $inputs.transactionTimestamp
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      duns: $response.body#/duns
      transactionTimestamp: $response.body#/transactionTimestamp
      originalResponse: $response.body#/originalResponse
  outputs:
    matchedDuns: $steps.matchCompany.outputs.topDuns
    auditTimestamp: $steps.getAuditRecord.outputs.transactionTimestamp
    originalResponse: $steps.getAuditRecord.outputs.originalResponse