openapi: 3.1.0
info:
  title: Admin Analyst Notificiation
  description: |-
    Admin analyst notifications are a collection of informative messages for the user within financial analytics. They can represent references to when a user has been added as a collaborator through having a resource shared with them, or when that access is revoked, as well as system generated alerts when thresholds are crossed.

    Notifications have different states to represent how they have been interacted with. A notification that is `viewed` means it has been presented to the user in the list of new notifications, whereas `read` means the user has specifically opened that notification. Notifications that are `read` are automatically `viewed`.

    The system will automatically remove notifications 30 days after they are created. A client may also explicitly [delete analyst notifications](#op-deleteAnalystNotifications).
  version: 0.3.0
  contact:
    name: Apiture
    url: https://developer.apiture.com/help/support/
    email: api@apiture.com
  termsOfService: https://developer.apiture.com/docs/Apiture-API-License-Agreement.pdf
  license:
    name: Apiture API License
    url: https://developer.apiture.com/docs/Apiture-API-License-Agreement.pdf
tags:
  - name: Analyst Notifications
    description: Analyst Notifications
  - name: Analyst Notification Actions
    description: Actions on Analyst Notifications
x-apiture-namespace: bankingAdminAnalystNotifications
servers:
  - url: /bankingAdmin
paths:
  /analystNotifications:
    get:
      summary: Fetch a representation of the analyst notifications
      description: Return the collection of analyst notification resources for the analyst identified in the access token.
      operationId: listAnalystNotifications
      x-apiture-api: bankingAdminAnalystNotifications
      x-apiture-group: analystNotifications
      tags:
        - Analyst Notifications
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analystNotifications'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
      security:
        - accessToken:
            - data/read
      x-apiture-permission: listAnalystNotifications
  /readAnalystNotifications:
    post:
      summary: Mark analyst notifications as read
      operationId: markAnalystNotificationsAsRead
      x-apiture-api: bankingAdminAnalystNotifications
      description: |-
        Mark a list of analyst notifications as `read`. Notifications that are already marked as `read` are not changed.

        This also marks the notifications as `viewed`.
      x-apiture-group: analystNotifications
      tags:
        - Analyst Notification Actions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bulkAnalystNotificationsRequest'
      responses:
        '200':
          description: |-
            OK. The request was successfully processed. However, updating the state of one or more notifications may have failed; the response body indicates which succeeded and which failed.

            This response may have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidNotificationIds/v1.0.0`](https://static.api.apiture.com/errors/invalidNotificationIds/v1.0.0)<br>
              One or more notification IDs are invalid or do not refer to an existing notification.
              Remediation: Specify the ID of a notification for the operation that the user requested.
            The `attributes` object in the error may have the properties defined for [`invalidNotificationIds`](https://static.api.apiture.com/errors/invalidNotificationIds/v1.0.0).
          x-apiture-errors:
            - invalidNotificationIds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bulkAnalystNotificationOperationResponse'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/bulkAnalystNotificationOperationResponse'
        '204':
          description: No Content. All analyst notifications were successfully marked as read.
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '422':
          description: Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/problemResponse'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
      security:
        - accessToken:
            - data/write
      x-apiture-permission: markAnalystNotificationsAsRead
  /unreadAnalystNotifications:
    post:
      summary: Mark the analyst notifications as unread
      operationId: markAnalystNotificationsAsUnread
      x-apiture-api: bankingAdminAnalystNotifications
      description: |-
        Mark a list of analyst notifications as `unread`. Notifications that are already marked as `unread` are not changed.

        Marking a notification as `unread` does not affect the value of the `viewed` property.
      x-apiture-group: analystNotifications
      tags:
        - Analyst Notification Actions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bulkAnalystNotificationsRequest'
      responses:
        '200':
          description: |-
            OK. The request was successfully processed. However, updating the `read` property of one or more notifications may have failed; the response body indicates which succeeded and which failed.

            This response may have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidNotificationIds/v1.0.0`](https://static.api.apiture.com/errors/invalidNotificationIds/v1.0.0)<br>
              One or more notification IDs are invalid or do not refer to an existing notification.
              Remediation: Specify the ID of a notification for the operation that the user requested.
            The `attributes` object in the error may have the properties defined for [`invalidNotificationIds`](https://static.api.apiture.com/errors/invalidNotificationIds/v1.0.0).
          x-apiture-errors:
            - invalidNotificationIds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bulkAnalystNotificationOperationResponse'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/bulkAnalystNotificationOperationResponse'
        '204':
          description: No Content. All analyst notifications were successfully marked as unread.
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '422':
          description: Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/problemResponse'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
      security:
        - accessToken:
            - data/write
      x-apiture-permission: markAnalystNotificationsAsUnread
  /viewedAnalystNotifications:
    post:
      summary: Mark analyst notifications as viewed
      operationId: markAnalystNotificationsAsViewed
      x-apiture-api: bankingAdminAnalystNotifications
      description: Mark a list of analyst notifications as `viewed`. Notifications that are already marked as `viewed` are not changed.
      x-apiture-group: analystNotifications
      tags:
        - Analyst Notification Actions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bulkAnalystNotificationsRequest'
      responses:
        '200':
          description: |-
            OK. The request was successfully processed. However, updating the state of one or more notifications may have failed; the response body indicates which succeeded and which failed.

            This response may have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidNotificationIds/v1.0.0`](https://static.api.apiture.com/errors/invalidNotificationIds/v1.0.0)<br>
              One or more notification IDs are invalid or do not refer to an existing notification.
              Remediation: Specify the ID of a notification for the operation that the user requested.
            The `attributes` object in the error may have the properties defined for [`invalidNotificationIds`](https://static.api.apiture.com/errors/invalidNotificationIds/v1.0.0).
          x-apiture-errors:
            - invalidNotificationIds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bulkAnalystNotificationOperationResponse'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/bulkAnalystNotificationOperationResponse'
        '204':
          description: No Content. All analyst notifications were successfully marked as viewed.
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '422':
          description: Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/problemResponse'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
      security:
        - accessToken:
            - data/write
      x-apiture-permission: markAnalystNotificationsAsViewed
  /deletedAnalystNotifications:
    post:
      summary: Delete analyst notifications
      operationId: deleteAnalystNotifications
      x-apiture-api: bankingAdminAnalystNotifications
      description: Delete a list of analyst notifications.
      x-apiture-group: analystNotifications
      tags:
        - Analyst Notification Actions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bulkAnalystNotificationsRequest'
      responses:
        '200':
          description: |-
            OK. The request was successfully processed. However, deleting of one or more notifications may have failed; the response body indicates which succeeded and which failed.

            This response may have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidNotificationIds/v1.0.0`](https://static.api.apiture.com/errors/invalidNotificationIds/v1.0.0)<br>
              One or more notification IDs are invalid or do not refer to an existing notification.
              Remediation: Specify the ID of a notification for the operation that the user requested.
            The `attributes` object in the error may have the properties defined for [`invalidNotificationIds`](https://static.api.apiture.com/errors/invalidNotificationIds/v1.0.0).
          x-apiture-errors:
            - invalidNotificationIds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bulkAnalystNotificationOperationResponse'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/bulkAnalystNotificationOperationResponse'
        '204':
          description: No Content. All analyst notifications were successfully deleted.
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '422':
          description: Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/problemResponse'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
      security:
        - accessToken:
            - data/write
      x-apiture-permission: deleteAnalystNotifications
components:
  schemas:
    analystNotifications:
      x-apiture-version: 1.1.0
      title: Analyst Notifications (v1.1.0)
      description: Collection of notifications for an analyst. The items in the collection are ordered in the `items` array.
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          required:
            - items
            - unreadCount
            - unviewedCount
          properties:
            unreadCount:
              description: The number of unread analyst notifications.
              type: integer
              format: int32
              minimum: 0
              maximum: 10000
            unviewedCount:
              description: The number of unviewed analyst notifications.
              type: integer
              format: int32
              minimum: 0
              maximum: 10000
            items:
              description: An array containing analyst notifications.
              type: array
              maxItems: 10000
              items:
                $ref: '#/components/schemas/analystNotificationItem'
      example:
        unreadCount: 1
        unviewedCount: 0
        items:
          - id: 0399abed-fd3d
            message: Insight 'FDIC Deposit Overage Account Holders' has been shared with you
            resource_url: https://static.api.apiture.com/bankingAdmin/analytics/insights/09220fdb-2112
            type: insight
            action: shared
            read: true
            viewed: true
            agent:
              id: d62c0701-0d74
              firstName: Benny
              lastName: Billings
              username: bbillings
              state: active
            viewedAt: '2023-05-12T17:32:26.000Z'
            readAt: '2023-05-12T17:32:26.000Z'
            createdAt: '2023-05-12T17:00:00.000Z'
            updatedAt: '2023-05-12T17:00:00.000Z'
          - id: 4c92592f-e0f7
            message: Access to audience 'Mortgage Prospects' has been revoked
            type: audience
            action: removedFromCollaborators
            read: false
            viewed: true
            agent:
              id: d62c0701-0d74
              firstName: Benny
              lastName: Billings
              username: bbillings
              state: active
            viewedAt: '2023-05-12T17:32:26.000Z'
            createdAt: '2023-05-12T17:00:00.000Z'
            updatedAt: '2023-05-12T17:00:00.000Z'
    analystNotificationItem:
      x-apiture-version: 1.1.0
      title: Analyst Notification Item (v1.1.0)
      description: Representation of an analyst notification resource.
      required:
        - id
        - message
        - type
        - action
        - read
        - viewed
        - createdAt
        - updatedAt
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/timestampFields'
        - type: object
          properties:
            id:
              description: The unique identifier for this analyst notification resource. This is an immutable opaque string.
              $ref: '#/components/schemas/readOnlyResourceId'
            message:
              description: The human-readable message for this notification.
              type: string
              format: text
              maxLength: 500
            resource_url:
              description: The location of the related resource, if applicable.
              type: string
              format: URL
              maxLength: 255
            type:
              description: The contextual type of the notification, such as a resource type or an alert.
              $ref: '#/components/schemas/analystNotificationType'
            action:
              description: The action represented by this notification.
              $ref: '#/components/schemas/analystNotificationAction'
            read:
              description: Whether the notification has been read or not.
              type: boolean
            viewed:
              description: Whether the notification has been viewed or not.
              type: boolean
            agent:
              description: The analyst who performed an action which triggered this notification. This field is ommitted when this notification is generated by the system.
              $ref: '#/components/schemas/userAccountReference'
            viewedAt:
              description: The date-time, if available, when the analyst has viewed the notification, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. This is derived and immutable.
              $ref: '#/components/schemas/readOnlyTimestamp'
            readAt:
              description: |-
                The date-time, if available, when the analyst has read the notification, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. This is derived and immutable.

                This value is reset when the notification is marked as `unread`.
              $ref: '#/components/schemas/readOnlyTimestamp'
      example:
        id: 0399abed-fd3d
        message: Insight 'FDIC Deposit Overage Account Holders' has been shared with you
        resource_url: https://static.api.apiture.com/bankingAdmin/analytics/insights/09220fdb-2112
        type: insight
        action: shared
        read: true
        viewed: true
        agent:
          id: d62c0701-0d74
          firstName: Benny
          lastName: Billings
          username: bbillings
          state: active
        viewedAt: '2023-05-12T17:32:26.000Z'
        readAt: '2023-05-12T17:32:26.000Z'
        createdAt: '2023-05-12T17:00:00.000Z'
        updatedAt: '2023-05-12T17:00:00.000Z'
    analystNotificationIds:
      title: Analyst Notification IDs (v1.0.0)
      description: A set of unique IDs of notification resources.
      type: array
      uniqueItems: true
      maxItems: 10000
      items:
        $ref: '#/components/schemas/resourceId'
      example:
        - 09220fdb-2112
        - 4c92592f-e0f7
        - 1ff3d7d4-4ac2
      x-apiture-version: 1.0.0
    bulkAnalystNotificationsRequest:
      title: Bulk Analyst Notifications Request (v1.0.0)
      description: A request to perform the operation on a set of notifications.
      type: object
      required:
        - notificationIds
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          properties:
            notificationIds:
              description: A list of notification references to perform the operation on.
              $ref: '#/components/schemas/analystNotificationIds'
      x-apiture-version: 1.0.0
    bulkAnalystNotificationOperationResponse:
      title: Bulk Analyst Notification Operation (v1.0.0)
      description: Bulk analyst notification operation response.
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          properties:
            items:
              description: The result of attempting to perform an action on a set of notifications in the request. Items in the array correspond (in order) to each of the notification IDs in the request.
              type: array
              minItems: 1
              maxItems: 10000
              items:
                description: The result of attempting to perform an action on one notification from the list of notifications in the request.
                $ref: '#/components/schemas/bulkAnalystNotificationOperationResponseItem'
      x-apiture-version: 1.0.0
    bulkAnalystNotificationOperationResponseItem:
      title: Bulk Notification Operation Item (v1.0.0)
      description: An item in a [bulk notification operation response](#schema-bulkAnalystNotificationOperationResponse).
      type: object
      required:
        - id
        - succeeded
      properties:
        id:
          description: The notification ID.
          $ref: '#/components/schemas/readOnlyResourceId'
        succeeded:
          description: '`true` if the operation was successful for the notification.'
          type: boolean
        problems:
          description: If the operation for this notification failed (`succeeded` is `false`), this describes why. This may include forbidden, conflict, or other 4xx error or problem types that can occur with individual notification operation calls.
          type: array
          maxItems: 10000
          items:
            $ref: '#/components/schemas/apiProblem'
      x-apiture-version: 1.0.0
    analystNotificationAction:
      x-apiture-version: 1.1.0
      title: Analyst Notification Action (v1.1.0)
      description: |+
        The action which triggered the notification.

        <strong><code>analystNotificationAction</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>shared</code></strong></td><td>Shared: <p>A resource has been shared with the analyst</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>addedToCollaborators</code></strong></td><td>Added to Collaborators: <p>The analyst has been added as a collaborator for a resource</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>removedFromCollaborators</code></strong></td><td>Removed from Collaborators: <p>The analyst has been removed as a collaborator for a resource</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>addedToOwners</code></strong></td><td>Added to Owners: <p>The analyst has been added as an owner for a resource</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>removedFromOwners</code></strong></td><td>Removed from Owners: <p>The analyst has been removed as an owner for a resource</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>archived</code></strong></td><td>Archived: <p>Another analyst has archived a resource that the analyst collaborates on</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>restored</code></strong></td><td>Restored: <p>Another analyst has restored a previously archived resource that the analyst collaborates on</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>triggered</code></strong></td><td>Triggered: <p>An alert that has been triggered by the system</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: analystNotificationAction
      enum:
        - shared
        - addedToCollaborators
        - removedFromCollaborators
        - addedToOwners
        - removedFromOwners
        - archived
        - restored
        - triggered
    analystNotificationType:
      title: Analyst Notification Type (v1.0.0)
      description: |+
        The contextual type of the notification.

        <strong><code>analystNotificationType</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>insight</code></strong></td><td>Insight: <p>A visualization of metrics or analytics for a financial institution</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>audience</code></strong></td><td>Audience: <p>A segment of financial institution customers that share a common set of attributes</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>dashboard</code></strong></td><td>Dashboard: <p>A dashboard containing a collection of insights</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>alert</code></strong></td><td>Alert: <p>A system generated alert regarding a metric or key performance indicator that crosses a threshold boundary or meets some other condition</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: analystNotificationType
      enum:
        - insight
        - audience
        - dashboard
        - alert
      x-apiture-version: 1.0.0
    problemResponse:
      title: Problem Response (v0.4.1)
      x-apiture-version: 0.4.1
      description: API problem or error response, as per [RFC 9457 application/problem+json](https://tools.ietf.org/html/rfc9457).
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/apiProblem'
      example:
        id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
        type: https://static.api.apiture.com/errors/noSuchAccount/v1.0.0
        title: Account Not Found
        status: 422
        occurredAt: '2022-04-25T12:42:21.375Z'
        detail: No account exists for the given account reference
        instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/problemResponse
    abstractBody:
      title: Abstract Body (v0.2.0)
      x-apiture-version: 0.2.0
      description: An abstract schema used to define other request and response body model schemas.
      x-apiture-fragment: true
      type: object
      properties: {}
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/abstractBody
    timestampFields:
      x-apiture-version: 1.1.0
      title: Timestamp Fields (v1.1.0)
      description: Timestamps which describe when a resource was created or last updated.
      x-apiture-fragment: true
      allOf:
        - $ref: '#/components/schemas/createdAtField'
        - type: object
          properties:
            updatedAt:
              description: The date-time when the resource was last updated, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. This is derived and immutable.
              $ref: '#/components/schemas/readOnlyTimestamp'
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/timestampFields
    readOnlyResourceId:
      x-apiture-version: 1.0.1
      title: Read-only Resource Identifier (v1.0.1)
      description: The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is also used in URLs as path parameters or in other properties or parameters that reference a resource by ID rather than URL. Resource IDs are immutable.
      readOnly: true
      allOf:
        - $ref: '#/components/schemas/resourceId'
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/readOnlyResourceId
    userAccountReference:
      x-apiture-version: 2.0.0
      title: User Account Reference (v2.0.0)
      description: The representation of a user account.
      type: object
      required:
        - id
        - firstName
        - lastName
        - username
      properties:
        id:
          description: The immutable, unique, opaque identifier for the user.
          $ref: '#/components/schemas/resourceId'
        firstName:
          description: The user's first name.
          type: string
          format: text
          maxLength: 56
        lastName:
          description: The user's last name.
          type: string
          format: text
          maxLength: 56
        username:
          description: The user's login name.
          $ref: '#/components/schemas/customerUsername'
      example:
        id: 0399abed-fd3d
        firstName: Benny
        lastName: Billings
        username: bbillings
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/userAccountReference
    readOnlyTimestamp:
      title: Read-Only Timestamp (v1.0.0)
      description: 'A readonly or derived timestamp (an instant in time) formatted in [RFC 3339](https://tools.ietf.org/html/rfc3339) `date-time` UTC format: `YYYY-MM-DDThh:mm:ss.sssZ`.'
      type: string
      minLength: 20
      maxLength: 30
      format: date-time
      readOnly: true
      example: '2021-10-30T19:06:04.250Z'
      x-apiture-since: 0.4.0
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/readOnlyTimestamp
      x-apiture-version: 1.0.0
    resourceId:
      x-apiture-version: 1.0.1
      title: Resource Identifier (v1.0.1)
      description: The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.
      type: string
      pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
      minLength: 6
      maxLength: 48
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/resourceId
    apiProblem:
      x-apiture-version: 1.2.1
      title: API Problem (v1.2.1)
      description: API problem or error, as per [RFC 7807 application/problem+json](https://tools.ietf.org/html/rfc7807).
      type: object
      properties:
        type:
          type: string
          format: uri-reference
          description: |
            A [URI reference (RFC3986)](https://tools.ietf.org/html/rfc3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`.
          example: https://static.api.apiture.com/errors/forbidden/v1.0.0
          maxLength: 2048
        title:
          type: string
          description: |
            A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`.
          maxLength: 120
          format: text
          example: User is not authorized to perform the requested action or access the requested resource.
        status:
          type: integer
          format: int32
          description: |
            The [HTTP status code](https://datatracker.ietf.org/doc/html/rfc7231#section-6) for this occurrence of the problem.
          minimum: 100
          maximum: 599
          example: 403
        detail:
          type: string
          description: |
            A human-readable explanation specific to this occurrence of the problem.
          maxLength: 256
          format: text
          example: User is not authorized to perform this operation.
        instance:
          type: string
          format: uri-reference
          description: |
            A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
          example: https://prduction.api.apiture.com/banking/accounts/ad80fc3e722q5402a#189c13ff-c54c-45f7-b8e0-c88984ba724d
          maxLength: 2048
        id:
          description: The unique identifier for this problem. This is an immutable opaque string.
          $ref: '#/components/schemas/readOnlyResourceId'
        occurredAt:
          description: The timestamp when the problem occurred, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC.
          $ref: '#/components/schemas/readOnlyTimestamp'
        problems:
          description: Optional root-causes if there are multiple problems in the request or API call processing.
          type: array
          maxItems: 128
          items:
            $ref: '#/components/schemas/apiProblem'
        attributes:
          type: object
          description: Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.
      example:
        id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
        type: https://static.api.apiture.com/errors/accountNotFound/v1.0.0
        title: Account Not Found
        status: 422
        occurredAt: '2022-04-25T12:42:21.375Z'
        detail: No account exists at the given account_url
        instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/apiProblem
    createdAtField:
      description: A field used to represent the `createdAt` date-time for a resource.
      x-apiture-fragment: true
      type: object
      properties:
        createdAt:
          description: The date-time when this resource was created, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. This is derived and immutable.
          $ref: '#/components/schemas/readOnlyTimestamp'
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/createdAtField
      x-apiture-version: 1.0.0
      title: ' (v1.0.0)'
    customerUsername:
      x-apiture-version: 2.0.0
      title: Customer Username (v2.0.0)
      description: A customer's login username.
      type: string
      format: text
      minLength: 5
      maxLength: 20
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/customerUsername
    requiredIdentityChallenge:
      x-apiture-version: 1.2.3
      title: Required Challenge (v1.2.3)
      description: A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 [Unauthorized problem response](#schema-apiProblem) when the 401 problem type name is `challengeRequired`. See the "Challenge API" for details.
      type: object
      required:
        - operationId
        - challengeId
        - factors
      properties:
        operationId:
          $ref: '#/components/schemas/challengeOperationId'
        challengeId:
          description: The unique ID of this challenge instance. This is an opaque string. This is passed when starting a challenge factor or when validating the identity challenge responses.
          $ref: '#/components/schemas/readOnlyResourceId'
        factors:
          description: 'A list of challenge factors. The user must complete one of these challenge factors. The `labels` in each factor identify one or more channels the user may use, such as a list of email addresses the system may use to send a one-time passcode to the user. ***Note**: The same channel may be used by multiple factors in the array of factors. For example, the user''s primary mobile phone number may be used for both an `sms` factor and a `voice` factor.'
          type: array
          minItems: 1
          maxItems: 8
          items:
            $ref: '#/components/schemas/challengeFactor'
      example:
        operationId: createTransfer
        challengeId: 0504076c566a3cf7009c
        factors:
          - type: sms
            labels:
              - '9876'
            id: 85c0ee5753fcd0b0953f
          - type: voice
            labels:
              - '9876'
            id: d089e10a80a8627df37b
          - type: voice
            labels:
              - '6754'
            id: 10506ecf9d1c2ee00403
          - type: email
            labels:
              - an****nk@example.com
              - an****98@example.com
            id: e917d671cb2f030b56f1
          - type: authenticatorToken
            labels:
              - Acme fob
            id: fe6c452d7da0bbb4e407
          - type: securityQuestions
            securityQuestions:
              questions:
                - id: q1
                  prompt: What is your mother's maiden name?
                - id: q4
                  prompt: What is your high school's name?
                - id: q9
                  prompt: What is the name of your first pet?
            id: df33c6f88a37d6b3f0a6
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/requiredIdentityChallenge
    challengeOperationId:
      x-apiture-version: 1.0.1
      title: Challenge Operation ID (v1.0.1)
      description: The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses.
      type: string
      pattern: ^[-a-zA-Z0-9$_]{6,48}$
      minLength: 6
      maxLength: 48
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengeOperationId
    challengeFactor:
      x-apiture-version: 1.2.1
      title: Challenge Factor (v1.2.1)
      description: A challenge factor. See [`requiredIdentityChallenge`](#schema-requiredIdentityChallenge) for multiple examples.
      type: object
      required:
        - type
      properties:
        id:
          description: |-
            The ID of an a challenge factor. This ID is unique within the challenge factors associated with a challenge. The client should pass this `id` value as the `factorId` when starting or verifying a challenge factor.

            *Note*: The `id` will become `required` in a future update to this schema.
          $ref: '#/components/schemas/challengeFactorId'
        type:
          $ref: '#/components/schemas/challengeFactorType'
        labels:
          description: A list of text label which identifies the channel(s) through which the user completes the challenge. For an `sms` or `voice` challenge, the only label item is the last four digits of the corresponding phone number. For an `email` challenge, each label is the masked email address.
          type: array
          minItems: 1
          maxItems: 4
          items:
            type: string
            maxLength: 300
            format: text
        securityQuestions:
          $ref: '#/components/schemas/challengeSecurityQuestions'
      example:
        type: sms
        labels:
          - '9876'
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengeFactor
    challengeFactorId:
      title: Challenge Factor ID (v1.0.0)
      description: The ID of an a challenge factor. This ID is unique within the factors offered with a challenge.
      type: string
      pattern: ^[-a-zA-Z0-9$_]{3,48}$
      minLength: 3
      maxLength: 48
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengeFactorId
      x-apiture-version: 1.0.0
    challengeFactorType:
      title: Challenge Factor Type (v1.0.0)
      description: |+
        The name of challenge factor.

        <strong><code>challengeFactorType</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>sms</code></strong></td><td>SMS: <p>One-time passcode sent to the primary mobile phone number</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>email</code></strong></td><td>Email: <p>One-time passcode sent to the primary email address</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>voice</code></strong></td><td>Voice: <p>One-time passcode communicated via automated voice phone call</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>authenticatorToken</code></strong></td><td>authenticator Token: <p>One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>securityQuestions</code></strong></td><td>Security Questions: <p>Prompt with the user&#39;s security questions registered with their security profile</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: challengeFactorType
      enum:
        - sms
        - email
        - voice
        - securityQuestions
        - authenticatorToken
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengeFactorType
      x-apiture-version: 1.0.0
    challengeSecurityQuestions:
      x-apiture-version: 1.0.1
      title: Challenge Security Questions (v1.0.1)
      description: Describes a `securityQuestions` challenge. This is omitted if the challenge `type` is not `securityQuestions`.
      type: object
      required:
        - questions
      properties:
        questions:
          description: The array of security questions.
          type: array
          minItems: 1
          maxItems: 8
          items:
            $ref: '#/components/schemas/challengeSecurityQuestion'
      example:
        questions:
          - id: q1
            prompt: What is your mother's maiden name?
          - id: q4
            prompt: What is your high school's name?
          - id: q9
            prompt: What is the name of your first pet?
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengeSecurityQuestions
    challengeSecurityQuestion:
      x-apiture-version: 1.0.1
      title: Challenge Security Question (v1.0.1)
      description: A single security question within the `questions` array of the [`challengeSecurityQuestions`](#schema-challengeSecurityQuestions)
      type: object
      required:
        - id
        - prompt
      properties:
        id:
          description: The unique ID of security question prompt. This should be included in the [`challengeVerification`](#schema-challengeVerification) response as the `promptId`.
          $ref: '#/components/schemas/challengePromptId'
        prompt:
          description: The text prompt of this security question.
          type: string
          format: text
          maxLength: 80
      example:
        id: 74699fa628911e762ea5
        prompt: What is your mother's maiden name?
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengeSecurityQuestion
    challengePromptId:
      title: Challenge Prompt ID (v1.0.0)
      description: The unique ID of a prompt (such as a security question) in a challenge factor.
      type: string
      pattern: ^[-_:.~$a-zA-Z0-9]+$
      minLength: 1
      maxLength: 48
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengePromptId
      x-apiture-version: 1.0.0
  securitySchemes:
    apiKey:
      type: apiKey
      name: API-Key
      in: header
      description: API Key based client identification. See details at [Secure Access](https://developer.apiture.com/docs/secure-access).
      x-resolved-from: ../../common/openapi.yaml#/components/securitySchemes/apiKey
    accessToken:
      type: openIdConnect
      description: OpenId Connect (OIDC) authentication/authorization. The client uses the `authorization_endpoint` and `token_endpoint` to obtain an access token to pass in the `Authorization` header. Those endpoints are available via the OIDC Configuration URL. The actual URL may vary with each financial institution. See details at [Secure Access](https://dx.apiture.com/docs/api/concepts/api-keys/).
      openIdConnectUrl: https://auth.apiture.com/oidc/.well-known/openid-configuration
      x-resolved-from: ../../common/openapi.yaml#/components/securitySchemes/accessToken
  x-apiture-errors:
    invalidNotificationIds:
      description: One or more notification IDs are invalid or do not refer to an existing notification.
      remediation: Specify the ID of a notification for the operation that the user requested.
      attributes:
        properties:
          invalidNotificationIds:
            description: The list of invalid notification IDs
            type: array
            minItems: 1
            maxItems: 1000
            items:
              type: string
              format: text
              maxLength: 48
    badRequest:
      description: The request body and/or parameters was not well-formed.
      remediation: Correct any syntax or schema errors in the request body or parameters.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/badRequest
    unauthorized:
      description: The request lacks valid authentication credentials for the target resource or operation.
      remediation: Authenticate the user and pass the required authorization with the request.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/unauthorized
    forbidden:
      description: The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access.
      remediation: Check the user's permissions and entitlements before attempting the operation.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/forbidden
    customerDisabled:
      description: The customer is disabled.
      remediation: Have the customer contact the financial institution for support.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/customerDisabled
    antiMalwareRequired:
      description: The financial institution requires the customer to have anti-malware software installed.
      remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/antiMalwareRequired
    modificationForbidden:
      description: The customer is properly authenticated but not authorized to create, modify, or delete resources.
      remediation: Avoid modification operation for customers with read-only authorization.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/modificationForbidden
    challengeRequired:
      description: The operation requires the customer to complete an identity challenge.
      remediation: Complete the challenge as per the problem response, and add an additional `Challenge` header to the call.
      attributes:
        $ref: '#/components/schemas/requiredIdentityChallenge'
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/challengeRequired
    challengeBlocked:
      description: The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication.
      remediation: Have the user end their login session and login again.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/challengeBlocked
    noIdentityChallengeFactors:
      description: This operation requires an identity challenge, but the user does not have the necessary registered authentication factors.
      remediation: Have the user register one or more challenge security code delivery factors.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/noIdentityChallengeFactors
    invalidIdentityChallengeHeader:
      description: The additional on-time `Challenge` header in this request is expired, already used, or otherwise invalid.
      remediation: Supply a valid, unexpired, unclaimed `Challenge` header in the request.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/invalidIdentityChallengeHeader
    tooManyRequests:
      description: The client has sent too many requests in a given amount of time, exceeding rate limiting.
      remediation: Slow down the rate of API calls.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/tooManyRequests
  responses:
    '204':
      description: No Content. The operation succeeded but returned no response body.
      x-resolved-from: ../../common/openapi.yaml#/components/responses/204
    '400':
      description: |
        Bad Request. The request body, request headers, and/or query parameters are not well-formed.

        This problem response may have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/badRequest/v1.0.0`](https://static.api.apiture.com/errors/badRequest/v1.0.0)<br>
          The request body and/or parameters was not well-formed.
          Remediation: Correct any syntax or schema errors in the request body or parameters.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/badRequest'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/badRequest/v1.0.0
              title: Bad Request
              status: 400
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: Input did not parse as JSON
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/badRequest/v1.0.0
              title: Bad Request
              status: 400
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: Input did not parse as JSON
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/400
    '401':
      description: |
        Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

        This problem response may have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/unauthorized/v1.0.0`](https://static.api.apiture.com/errors/unauthorized/v1.0.0)<br>
          The request lacks valid authentication credentials for the target resource or operation.
          Remediation: Authenticate the user and pass the required authorization with the request.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/unauthorized'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/unauthorized/v1.0.0
              title: Unauthorized
              status: 401
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The request lacks valid authentication credentials
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/unauthorized/v1.0.0
              title: Unauthorized
              status: 401
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The request lacks valid authentication credentials
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/401
    '403':
      description: |
        Forbidden. The authenticated caller is not authorized to perform the requested operation.

        This problem response may have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/forbidden/v1.0.0`](https://static.api.apiture.com/errors/forbidden/v1.0.0)<br>
          The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access.
          Remediation: Check the user's permissions and entitlements before attempting the operation.

        * [`https://static.api.apiture.com/errors/customerDisabled/v1.0.0`](https://static.api.apiture.com/errors/customerDisabled/v1.0.0)<br>
          The customer is disabled.
          Remediation: Have the customer contact the financial institution for support.

        * [`https://static.api.apiture.com/errors/antiMalwareRequired/v1.0.0`](https://static.api.apiture.com/errors/antiMalwareRequired/v1.0.0)<br>
          The financial institution requires the customer to have anti-malware software installed.
          Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.

        * [`https://static.api.apiture.com/errors/modificationForbidden/v1.0.0`](https://static.api.apiture.com/errors/modificationForbidden/v1.0.0)<br>
          The customer is properly authenticated but not authorized to create, modify, or delete resources.
          Remediation: Avoid modification operation for customers with read-only authorization.

        * [`https://static.api.apiture.com/errors/challengeRequired/v1.0.0`](https://static.api.apiture.com/errors/challengeRequired/v1.0.0)<br>
          The operation requires the customer to complete an identity challenge.
          Remediation: Complete the challenge as per the problem response, and add an additional `Challenge` header to the call.
        The `attributes` object in the error may have the properties defined by the [`requiredIdentityChallenge` schema](#schema-requiredIdentityChallenge).
        * [`https://static.api.apiture.com/errors/challengeBlocked/v1.0.0`](https://static.api.apiture.com/errors/challengeBlocked/v1.0.0)<br>
          The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication.
          Remediation: Have the user end their login session and login again.

        * [`https://static.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0`](https://static.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0)<br>
          This operation requires an identity challenge, but the user does not have the necessary registered authentication factors.
          Remediation: Have the user register one or more challenge security code delivery factors.

        * [`https://static.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0`](https://static.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0)<br>
          The additional on-time `Challenge` header in this request is expired, already used, or otherwise invalid.
          Remediation: Supply a valid, unexpired, unclaimed `Challenge` header in the request.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/forbidden'
        - $ref: '#/components/x-apiture-errors/customerDisabled'
        - $ref: '#/components/x-apiture-errors/antiMalwareRequired'
        - $ref: '#/components/x-apiture-errors/modificationForbidden'
        - $ref: '#/components/x-apiture-errors/challengeRequired'
        - $ref: '#/components/x-apiture-errors/challengeBlocked'
        - $ref: '#/components/x-apiture-errors/noIdentityChallengeFactors'
        - $ref: '#/components/x-apiture-errors/invalidIdentityChallengeHeader'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/forbidden/v1.0.0
              title: Forbidden
              status: 403
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The request has valid authentication, but the authenticated agent is forbidden from accessing this resource or operation
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/forbidden/v1.0.0
              title: Forbidden
              status: 403
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The request has valid authentication, but the authenticated agent is forbidden from accessing this resource or operation
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/403
    '429':
      description: |
        Too Many Requests. The client has sent too many requests in a given amount of time.

        This problem response may have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/tooManyRequests/v1.0.0`](https://static.api.apiture.com/errors/tooManyRequests/v1.0.0)<br>
          The client has sent too many requests in a given amount of time, exceeding rate limiting.
          Remediation: Slow down the rate of API calls.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/tooManyRequests'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/tooManyRequests/v1.0.0
              title: Too Many Requests
              status: 429
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The user has sent too many requests in a given amount of time.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/tooManyRequests/v1.0.0
              title: Too Many Requests
              status: 429
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The user has sent too many requests in a given amount of time.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/429
    4XX:
      description: Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/methodNotAllowed/v1.0.0
              title: Method Not Allowed
              status: 405
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: This HTTP method is not allowed for the given resource URL.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/methodNotAllowed/v1.0.0
              title: Method Not Allowed
              status: 405
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: This HTTP method is not allowed for the given resource URL.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/4XX
    5XX:
      description: Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/gatewayTimeout/v1.0.0
              title: Insufficient Storage
              status: 507
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The server is unable to store the representation needed to successfully complete the request.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/gatewayTimeout/v1.0.0
              title: Insufficient Storage
              status: 507
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The server is unable to store the representation needed to successfully complete the request.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/5XX
x-apiture-traits:
  - api:
      name: admin analyst notifications
      namespace: bankingAdminAnalystNotifications
      links: []
      applied: true
  - singleton:
      name: analyst notifications
      description: Lists notifications for analysts using FI Analytics
      immutable: true
      applied: true
  - action:
      name: analyst notification
      verb: read
      state: read
      etag: false
      applied: true
  - action:
      name: analyst notification
      verb: unread
      state: unread
      etag: false
      applied: true
  - action:
      name: analyst notification
      verb: delete
      state: deleted
      etag: false
      applied: true
  - action:
      name: analyst notification
      verb: view
      state: viewed
      etag: false
      applied: true
  - security:
      baseScope: data
x-resolved-from: ../../adminAnalystNotifications/status-codes-openapi.yaml
x-resolved-at: '2024-12-09T22:00:47.736Z'
x-apiture-annotated-at: '2024-12-09T22:00:47.964Z'
