openapi: 3.2.0
info:
  title: Vonage Transaction API
  version: 1.1.0
  contact:
    name: Vonage DevRel
    email: devrel@vonage.com
    url: https://developer.nexmo.com/
  x-metaDescription: Find quick answers to questions about the Vonage Redact API in this reference guide. Learn more in Vonage's API documentation.
  x-metaTitle: Vonage Redact API Reference | Vonage API Documentation
  description: 'Operations tagged Transaction across 2 of this provider''s published API definitions: vonage-redact-openapi.json, vonage-redact-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.nexmo.com/v1/redact
tags:
- name: Transaction
paths:
  /transaction:
    post:
      summary: Redact a specific message
      operationId: redact-message
      description: ''
      security:
      - basicAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RedactTransaction'
      responses:
        '204':
          description: Success
        '401':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorUnauthorized'
        '403':
          description: Authorisation denied
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ErrorPrematureRedaction'
                - $ref: '#/components/schemas/ErrorUnprovisioned'
        '404':
          description: No such record
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInvalidId'
        '422':
          description: Invalid JSON body
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ErrorInvalidJson'
                - $ref: '#/components/schemas/ErrorUnsupportedProduct'
        '429':
          description: Rate Limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorThrottled'
      tags:
      - Transaction
    servers:
    - url: https://api.nexmo.com/v1/redact
components:
  schemas:
    ErrorPrematureRedaction:
      description: Premature Redaction
      type: object
      required:
      - type
      - title
      - detail
      - instance
      properties:
        type:
          type: string
          description: Link to error / remediation options
          example: https://developer.nexmo.com/api-errors/redact#premature-redaction
        title:
          type: string
          description: Generic error message
          example: Premature Redaction
        detail:
          type: string
          description: Additional information about the error
          example: You must wait 60 minutes before redacting ID '0A000000B0C9A1234'
        instance:
          type: string
          description: Internal Trace ID
          example: bf0ca0bf927b3b52e3cb03217e1a1ddf
    ErrorUnsupportedProduct:
      description: Unsupported Product
      type: object
      required:
      - type
      - title
      - detail
      - instance
      properties:
        type:
          type: string
          description: Link to error / remediation options
          example: https://developer.nexmo.com/api-errors/redact#invalid-product
        title:
          type: string
          description: Generic error message
          example: Invalid Product
        detail:
          type: string
          description: Additional information about the error
          example: No product corresponding to supplied string sms2!
        instance:
          type: string
          description: Internal Trace ID
          example: bf0ca0bf927b3b52e3cb03217e1a1ddf
    ErrorUnauthorized:
      type: object
      required:
      - type
      - error_title
      properties:
        type:
          type: string
          description: Machine readable error type
          example: UNAUTHORIZED
        error_title:
          type: string
          description: Error title
          example: Unauthorized
    ErrorThrottled:
      type: object
      required:
      - type
      - title
      - detail
      - instance
      properties:
        type:
          type: string
          description: Link to error / remediation options
          example: https://developer.nexmo.com/api-errors/redact#rate-limit
        title:
          type: string
          description: Generic error message
          example: Rate Limit Hit
        detail:
          type: string
          description: Additional information about the error
          example: Please wait, then retry your request
        instance:
          type: string
          description: Internal Trace ID
          example: bf0ca0bf927b3b52e3cb03217e1a1ddf
    ErrorUnprovisioned:
      description: Unprovisioned
      type: object
      required:
      - type
      - title
      - detail
      - instance
      properties:
        type:
          type: string
          description: Link to error / remediation options
          example: https://developer.nexmo.com/api-errors#unprovisioned
        title:
          type: string
          description: Generic error message
          example: Authorisation error
        detail:
          type: string
          description: Additional information about the error
          example: User=ABC123 is not provisioned to redact product=SMS
        instance:
          type: string
          description: Internal Trace ID
          example: bf0ca0bf927b3b52e3cb03217e1a1ddf
    RedactTransaction:
      type: object
      required:
      - id
      - product
      - type
      properties:
        id:
          type: string
          description: The transaction ID to redact
          example: 209ab3c7536542b91e8b5aef032f6861
        product:
          type: string
          example: sms
          description: Product name that the ID provided relates to
          enum:
          - sms
          - voice
          - number-insight
          - verify
          - verify-sdk
          - messages
          - network-api-event
          - vonage-qod
        type:
          type: string
          enum:
          - inbound
          - outbound
          example: outbound
          default: outbound
          description: Required if redacting SMS data
    ErrorInvalidJson:
      description: Invalid JSON
      type: object
      required:
      - type
      - title
      - detail
      - instance
      properties:
        type:
          type: string
          description: Link to error / remediation options
          example: https://developer.nexmo.com/api-errors#invalid-json
        title:
          type: string
          description: Generic error message
          example: Invalid JSON
        detail:
          type: string
          description: Additional information about the error
          example: 'Unexpected character (''"'' (code 34)): was expecting comma to separate Object entries'
        instance:
          type: string
          description: Internal Trace ID
          example: bf0ca0bf927b3b52e3cb03217e1a1ddf
    ErrorInvalidId:
      type: object
      required:
      - type
      - title
      - detail
      - instance
      properties:
        type:
          type: string
          description: Link to error / remediation options
          example: https://developer.nexmo.com/api-errors#invalid-id
        title:
          type: string
          description: Generic error message
          example: Invalid ID
        detail:
          type: string
          description: Additional information about the error
          example: ID '0A000000B0C9A1234' could not be found (type=MT)
        instance:
          type: string
          description: Internal Trace ID
          example: bf0ca0bf927b3b52e3cb03217e1a1ddf
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
x-refined-from:
- vonage-redact-openapi.json
- vonage-redact-openapi.yml
x-errors:
  validation:
    description: The provided payload is invalid
    resolution: 'Modify your request to provide a valid payload.

      * Minimum 8 characters

      * Maximum 25 characters

      * Minimum 1 lower case character

      * Minimum 1 upper case character

      * Minimum 1 digit

      '
    link:
      text: View API reference
      url: /api/account#createAPISecret
  delete-last-secret:
    description: You can not delete your only API secret
    resolution: Add another API secret before deleting this one