Salv manual-alerts API

openapi: 3.0.3
info:
  title: Salv AML alert manual-alerts API
  description: '# Introduction

    Welcome to the Salv AML API documentation.


    The Salv API is built on HTTP. Our API is RESTful. It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. You can use your favorite HTTP/REST library for your programming language to use Salv API.


    API definition to import into Postman can be downloaded at https://docs.salv.com/api/public.yaml

    '
  version: 1.0.9
  contact:
    name: Support
    email: support@salv.com
  x-logo:
    url: salv.svg
    altText: Salv API
servers:
- url: https://{environment}.salv.com/api/
  variables:
    environment:
      default: app
      enum:
      - app
      - demo
      description: 'Select environment:

        * `app` - Production

        * `demo` - Sandbox

        '
security:
- OAuth2:
  - aml
tags:
- name: manual-alerts
  description: 'Manual alerts allow compliance officers to create alerts manually for persons or transactions that require investigation

    outside of automated monitoring and screening processes. These alerts can be used to flag suspicious activity identified

    through external sources, customer complaints, or other manual review processes.


    Manual alerts support the same status workflow as other alert types and can be integrated into existing case management processes.

    '
  x-displayName: Manual Alerts
paths:
  /v1/manual-alerts:
    post:
      tags:
      - manual-alerts
      operationId: createManualAlert
      summary: Create manual alert
      description: Creates a new manual alert for a person or transaction.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: models.yaml#/components/schemas/ApiCreateManualAlert
      responses:
        '200':
          description: Successfully created manual alert
          content:
            application/json:
              schema:
                $ref: models.yaml#/components/schemas/ApiManualAlert
        '400':
          description: Invalid data
        '404':
          description: Person or transaction not found
  /v1/manual-alerts/{alertId}:
    put:
      tags:
      - manual-alerts
      operationId: updateManualAlert
      summary: Update manual alert
      description: Updates a manual alert including rationale, comment, and optionally status.
      parameters:
      - name: alertId
        in: path
        description: ID of manual alert to update
        required: true
        schema:
          type: integer
          format: int64
          minimum: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: models.yaml#/components/schemas/ApiUpdateManualAlert
      responses:
        '200':
          description: Successfully updated manual alert
          content:
            application/json:
              schema:
                $ref: models.yaml#/components/schemas/ApiManualAlert
        '400':
          description: Invalid data
        '404':
          description: Manual alert not found
components:
  securitySchemes:
    OAuth2:
      type: oauth2
      description: 'In order to use the API, you need to generate client credentials using [Salv UI](https://demo.salv.com/credentials).

        Never share your secret keys. Keep them guarded and secure.


        We use OAuth2 client credentials flow to issue our API tokens.

        By default our API tokens have expiration time of 50 years, so effectively they never expire.

        Please do not make any assumptions about the content of the access_token.

        At the moment we use a JWT token, but it can change to any other string with the future updates.


        An API token can be invalidated using Salv UI by deleting the client credentials that were used to generate the token.


        Please make sure you only request it once per reasonable amount of time,

        as `oauth/token` endpoint has a rate limit of **10 requests per minute** per IP address.


        | Environment | Token URL |

        |-------------|-----------|

        | Production | `https://app.salv.com/oauth/token` |

        | Sandbox | `https://demo.salv.com/oauth/token` |


        Use the token URL matching your selected server environment.

        '
      flows:
        clientCredentials:
          tokenUrl: https://app.salv.com/oauth/token
          x-tokenUrl-sandbox: https://demo.salv.com/oauth/token
          scopes:
            aml: Can use AML API
x-tagGroups:
- name: General
  tags:
  - changelog
  - getting-started
  - data-upload
  - aml
  - note
  - webhooks
  - custom-list-record
  - custom-list-usable-field-public
- name: Monitoring
  tags:
  - monitoring-overview
  - monitoring-checks
  - alert
- name: Screening
  tags:
  - screening-overview
  - screening-checks
  - screening-searches
  - screening-list-groups
  - screening-alerts
- name: Risks
  tags:
  - risk
- name: Alert management
  tags:
  - alerts
  - manual-alerts
- name: Deprecated
  tags:
  - unresolved-alerts