Socure Monitoring Offboard

arazzo: 1.0.1
info:
  title: Socure Monitoring Offboard
  summary: Confirm a watchlist monitoring profile is active, then remove it when a customer is offboarded.
  description: >-
    The offboarding flow for continuous watchlist monitoring. The workflow reads
    a monitoring profile to confirm it exists and is active, then removes it so
    the identity is no longer screened against newly added or updated list
    entries. Every step inlines its request so the offboarding flow can be read
    and executed without opening the underlying OpenAPI description.
  version: 1.0.0
sourceDescriptions:
- name: watchlistApi
  url: ../openapi/socure-watchlist-monitoring-api-openapi.yml
  type: openapi
workflows:
- workflowId: monitoring-offboard
  summary: Confirm and then remove a watchlist monitoring profile.
  description: >-
    Retrieves a monitoring profile to confirm it is active, then deletes it to
    stop continuous watchlist monitoring for the offboarded customer.
  inputs:
    type: object
    required:
    - apiKey
    - profileId
    properties:
      apiKey:
        type: string
        description: Socure API key presented as `SocureApiKey <api-key>`.
      profileId:
        type: string
        description: Monitoring profile to confirm and remove.
  steps:
  - stepId: confirmProfile
    description: >-
      Read the monitoring profile to confirm it exists and capture its current
      status before removal.
    operationId: getMonitoringProfile
    parameters:
    - name: Authorization
      in: header
      value: SocureApiKey $inputs.apiKey
    - name: profileId
      in: path
      value: $inputs.profileId
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      profileId: $response.body#/profileId
      customerUserId: $response.body#/customerUserId
      status: $response.body#/status
  - stepId: removeProfile
    description: >-
      Remove the monitoring profile so the identity is no longer screened against
      watchlist updates.
    operationId: removeMonitoringProfile
    parameters:
    - name: Authorization
      in: header
      value: SocureApiKey $inputs.apiKey
    - name: profileId
      in: path
      value: $steps.confirmProfile.outputs.profileId
    successCriteria:
    - condition: $statusCode == 204
  outputs:
    profileId: $steps.confirmProfile.outputs.profileId
    customerUserId: $steps.confirmProfile.outputs.customerUserId