openapi: 3.1.0
info:
  title: Webhook Client Administration
  description: |-
    This API allows Dev Portal administrators to manage partner webhook clients. A webhook client is a web service with an authenticated URL where Apiture Digital Banking (ADB) sends digital banking event messages via HTTP `POST`. See the Events Administration for a catalog of event categories and event types.

    The primary consumer of this internal API is Dev Portal Administration pages in the Apiture Developer Portal.

    This API supports the following Apiture administrative operations for Dev Portal Administrators (using `adminAccessToken` security)

      * [List webhook clients for all partners](#op-listAllWebhookClients)
      * [Verify a webhook](#op-verifyWebhookClient) - send a test message to the webhook URL
      to verify the client's webhook service works.
      * Reviewing/adjudicating the webhook client:
        * Approve webhook clients. Approval is performed by
        [`activateWebhookClient`](#op-activateWebhookClient)
        * [Reject webhook client applications](#op-rejectWebhookClient)
      * If either Apiture or the financial institution suspect malicious use or a security risk,
      an administrator can [deactivate](#op-activateWebhookClient) the webhook client,
      which changes its state to `inactive`.
      * An `inactive` webhook client can only be [activated](#op-activateWebhookClient) by admin access.

    See also the _suspend_ and _resume_ self-service operations in the developer-facing Webhook Clients API.
  version: 0.2.1
  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
x-apiture-namespace: adminWebhookClients
x-apiture-package-name: admin-webhook-clients
servers:
  - url: /devAdmin
tags:
  - name: Webhook Client Administration
    description: Webhook Client Administration
  - name: Webhook Client Administration Actions
    description: Administrative actions on Webhook Clients
paths:
  /allWebhookClients:
    get:
      tags:
        - Webhook Client Administration
      x-apiture-group: webhookClientsAdmin
      summary: Fetch the list of all existing webhook clients
      description: Fetch the list of existing webhook clients.
      operationId: listAllWebhookClients
      x-apiture-api: adminWebhookClients
      security:
        - adminAccessToken:
            - admin/read
      parameters:
        - name: institution
          description: Include in the list only webhook clients which listen to events from the financial institution whose institution ID matches this string.
          in: query
          schema:
            $ref: '#/components/schemas/institutionId'
        - name: environment
          description: Include in the list only webhook clients which listen to events from the API environments whose environment ID matches this string. (An API environment is a resource that names an institution and a deployment level like `prod` or `cat`; see the API Environments API.)
          in: query
          schema:
            $ref: '#/components/schemas/resourceId'
        - name: state
          description: Include in the response only webhook clients whose `state` is in this pipe-delimited list.
          in: query
          style: pipeDelimited
          explode: false
          schema:
            type: array
            uniqueItems: true
            minItems: 1
            maxItems: 4
            items:
              $ref: '#/components/schemas/webhookClientState'
        - name: partner
          in: query
          description: Filter webhooks by partner email address (case insensitive).
          schema:
            type: string
            format: email
            minLength: 8
            maxLength: 255
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhookClients'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/webhookClients'
        '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.

            This problem response may have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/unprocessableEntity/v1.0.0`](https://static.api.apiture.com/errors/unprocessableEntity/v1.0.0)<br>
              The syntax of the request entity is correct but was unable to process the contained instructions.
              Remediation: Provide a semantically correct request.

            * [`https://static.api.apiture.com/errors/invalidStart/v1.0.0`](https://static.api.apiture.com/errors/invalidStart/v1.0.0)<br>
              The `start` query parameter is invalid.
              Remediation: Use the `nextPage_url` in the previous response (and its service-generated `?start=` parameter) to access the next page.
          x-apiture-errors:
            - $ref: '#/components/x-apiture-errors/unprocessableEntity'
            - $ref: '#/components/x-apiture-errors/invalidStart'
          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'
    delete:
      summary: Delete Webhook Client
      description: Delete a partner's webhook client. This is only allowed if `state` is `suspended`, `rejected` or `inactive`.
      operationId: deletePartnerWebhookClient
      x-apiture-api: adminWebhookClients
      tags:
        - Webhook Client Administration
      security:
        - adminAccessToken:
            - admin/write
      x-apiture-group: adminWebhookClients
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paginatedWebhookClients'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/paginatedWebhookClients'
        '204':
          description: No content.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409webhookClient'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
  /webhookClients/{webhookClientId}/activated:
    parameters:
      - $ref: '#/components/parameters/webhookClientIdPathParam'
    post:
      summary: Activate the webhook
      description: |-
        Activate the webhook. This provisions the webhook client in the system so the system may begin POSTing messages to the webhook client.

        This is only allowed if `webhook.verified` is `true`.

        This operation is idempotent and has no effect if the webhook client's `state` is `active`.
      operationId: activateWebhookClient
      x-apiture-api: adminWebhookClients
      tags:
        - Webhook Client Administration Actions
      x-apiture-group: webhookClientActions
      security:
        - adminAccessToken:
            - admin/write
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhookClient'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/webhookClient'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409webhookClient'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
  /webhookClients/{webhookClientId}/deactivated:
    parameters:
      - $ref: '#/components/parameters/webhookClientIdPathParam'
    post:
      summary: Deactivate the webhook
      description: |-
        Deactivate the webhook. Stop sending messages to the webhook. An administrator may deactivate a webhook at the request of the webhook client owner or the financial institution if Apiture or the financial institution suspect fraudulent activity, security risks, or a violation of terms of use associated with the webhook client.

        This can be reversed with [`activateWebhookClient`](#op-activateWebhookClient)

        This operation is idempotent and has no effect if the webhook client's `state` is `inactive`.

        This operation is not allowed if the state is `rejected`.
      operationId: deactivateWebhookClient
      x-apiture-api: adminWebhookClients
      tags:
        - Webhook Client Administration Actions
      x-apiture-group: webhookClientActions
      security:
        - adminAccessToken:
            - admin/write
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhookClient'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/webhookClient'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409webhookClient'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
  /webhookClients/{webhookClientId}/rejected:
    parameters:
      - $ref: '#/components/parameters/webhookClientIdPathParam'
    post:
      summary: Reject the webhook
      description: |-
        Reject a webhook client. This is only allowed if the webhook `state` is `inactive` or `submitted` (i.e. a new webhook client).

        This is one of two actions an administrator may take in response to a developer submitting a webhook client. This can be overruled by an administrator calling [`activateWebhookClient`](#op-activateWebhookClient).

        This operation is idempotent and has no effect if the webhook client's `rejected`.
      operationId: rejectWebhookClient
      x-apiture-api: adminWebhookClients
      tags:
        - Webhook Client Administration Actions
      x-apiture-group: webhookClientActions
      security:
        - adminAccessToken:
            - admin/write
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhookClient'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/webhookClient'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409webhookClient'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
  /webhookClients/{webhookClientId}/verified:
    parameters:
      - $ref: '#/components/parameters/webhookClientIdPathParam'
    post:
      summary: Verify the webhook
      description: |-
        Verify the webhook. This `POST`s a sample message payload to the webhook URL to verify that it is working. Any 2XX response from the webhook URL indicates the webhook is working and results in a `{ "verified": true }` value in the response body associated with the 200 OK response from this operation.
        If the HTTP response code from the `POST` to the URL is not a 2XX-level value, this operation still returns a 200 response. (That is, it is not a error to attempt to verify the webhook when the webhook is broken.) If the webhook fails, the response body associated with the 200 OK response from this operation contains a `false` validation result in the `verified` property of the target webhook client. The webhook owner can see this result and may attempt to fix the problem with the `replaceWebhookClient` operation in the Dev Portal (via the developer Webhook Client API).
      operationId: verifyWebhookClient
      x-apiture-api: adminWebhookClients
      tags:
        - Webhook Client Administration Actions
      x-apiture-group: webhookClientActions
      security:
        - adminAccessToken:
            - data/write
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhookClient'
            application/vnd.restful+json:
              schema:
                $ref: '#/components/schemas/webhookClient'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
components:
  responses:
    '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
    '404':
      description: |
        Not found. There is no such resource at the request URL.

        This problem response may have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/notFound/v1.0.0`](https://static.api.apiture.com/errors/notFound/v1.0.0)<br>
          The resource at the requested URL does not exist.
          Remediation: Use the URL of an existing resource.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/notFound'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/notFound/v1.0.0
              title: Not Found
              status: 404
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The resource at the request URL does not exist.
              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/notFound/v1.0.0
              title: Not Found
              status: 404
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The resource at the request URL does not exist.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/404
    '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
    409webhookClient:
      description: |
        Conflict.

        This problem response may have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/invalidWebhookClientState/v1.0.0`](https://static.api.apiture.com/errors/invalidWebhookClientState/v1.0.0)<br>
          The requested operation is not allowed for a webhook in current state.
          Remediation: Only invoke operations allowed for the given state.
      x-apiture-errors:
        - invalidWebhookClientState
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
    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
  schemas:
    paginatedWebhookClients:
      title: Paginated Webhook Clients (v1.0.0)
      description: A page of webhook clients, from a collection of webhook clients. Use the `nextPage_url` property in the response to fetch the next page of webhook clients.
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractPagedBody'
        - type: object
          properties:
            items:
              description: The webhook clients in this page of the webhook clients.
              type: array
              maxItems: 1000
              items:
                $ref: '#/components/schemas/webhookClientItem'
      example:
        nextPage_url: https://api.developer.apiture.com/devWebhookClients/webhookClients?start=cursor123&limit=100
        limit: 100
        items:
          - id: 0836e727-e8d7-482f-9254-4a0fa5d83950
            environmentId: 6232502ab11b58963615
            state: active
            verified: true
            url: https://webhooks.example.com/fraud/live-monitoring
            description: My live fraud monitoring listener
            categories:
              - accounts
              - externalAccounts
              - authentication
              - entitlements
              - transfers
            authorizationType: oauthClientCredentials
            oauthClientCredentialsAuthorization:
              token_url: https://www.example.com/auth/token
              scope: events/push
            createdAt: '2024-06-10T09:13:47.375Z'
      x-apiture-version: 1.0.0
    institutionId:
      x-apiture-version: 1.1.0
      title: Institution ID (v1.1.0)
      description: The unique immutable identifier of a financial institution.
      type: string
      pattern: ^[A-Z0-9_]{2,8}$
      maxLength: 8
      minLength: 2
      example: TIBURON
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/institutionId
    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
    webhookClientState:
      title: Webhook Client State (v1.0.0)
      type: string
      description: |+
        The state of the webhook.

        <strong><code>webhookClientState</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>inactive</code></strong></td><td>Inactive: <p>The client webhook is inactive; the system does not attempt to send messages to it until an administrtaor activates it</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>active</code></strong></td><td>Active: <p>The client webhook is verified and active; the system attempts to send messages to it.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>submitted</code></strong></td><td>Submitted: <p>The webhook client owner has submitted the webhook for review, approval, and provisioning</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>suspended</code></strong></td><td>Suspended: <p>The client webhook owner has suspended the client webhook; the system does not attempt to send messages to it until an owner resumes the webhook</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>rejected</code></strong></td><td>Rejected: <p>An administrator has rejected (not approved) a webhook client registration</p>
        </td>
            </tr>
        </table>

      x-apiture-enum: webhookClientState
      enum:
        - inactive
        - submitted
        - active
        - suspended
        - rejected
      x-resolved-from: ../../devWebhookClients/openapi.yaml#/components/schemas/webhookClientState
      x-apiture-version: 1.0.0
    webhookClients:
      x-apiture-version: 1.0.1
      title: Webhook Clients (v1.0.1)
      description: A list of the partner's webhooks client.
      type: object
      required:
        - items
      allOf:
        - $ref: '#/components/schemas/abstractPagedBody'
        - type: object
          properties:
            items:
              description: The webhooks in this page of the webhook clients.
              type: array
              maxItems: 1000
              items:
                $ref: '#/components/schemas/webhookClientItem'
      example:
        nextPage_url: https://api.developer.apiture.com/devWebhookClients/webhookClients?start=cursor123&limit=100
        limit: 100
        items:
          - id: 0836e727e8d74a0fa5d83950
            environmentId: daafc39caac452708618a117
            state: active
            verified: true
            url: https://webhooks.example.com/fraud/live-monitoring
            description: My live fraud monitoring listener
            categories:
              - accounts
              - externalAccounts
              - authentication
              - entitlements
              - transfers
            authorizationType: oauthClientCredentials
            oauthClientCredentialsAuthorization:
              token_url: https://www.example.com/auth/token
              scope: events/push
            createdAt: '2024-06-10T09:13:47.375Z'
      x-resolved-from: ../../devWebhookClients/openapi.yaml#/components/schemas/webhookClients
    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
    webhookClient:
      x-apiture-version: 1.0.1
      title: Webhook Client (v1.0.1)
      description: A webhook client.
      type: object
      required:
        - id
        - description
        - environmentId
        - url
        - categories
        - authorizationType
        - state
        - verified
        - createdAt
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/webhookClientFields'
        - $ref: '#/components/schemas/timestampFields'
        - type: object
          properties:
            basicAuthorization:
              description: The webhook authorization values for HTTP `Basic` authentication. This object is present if the `authorizationType` is `basic` and absent otherwise.
              allOf:
                - $ref: '#/components/schemas/webhookClientBasicAuthorization'
            oauthClientCredentialsAuthorization:
              description: The webhook authorization values for OAuth2 client credentials flow authentication. This object is present if the `authorizationType` is `oathClientCredentials` and absent otherwise.
              allOf:
                - $ref: '#/components/schemas/webhookClientOAuthAuthorization'
      example:
        id: 0836e727e8d74a0fa5d83950
        environmentId: daafc39caac452708618a117
        state: active
        verified: true
        url: https://webhooks.example.com/fraud/live-monitoring
        description: My live fraud monitoring listener
        categories:
          - accounts
          - externalAccounts
          - authentication
          - entitlements
          - transfers
        authorizationType: oauthClientCredentials
        oauthClientCredentialsAuthorization:
          token_url: https://www.example.com/auth/token
          clientId: 6f16b758-0b5e-4c4a-9746-c6d93dbda51b
          clientSecret: hEl4+89d%^/dP*@djZ=<T$UgK#/RZxyJb1
          scope: events/push
        owners:
          - walter.white@example.com
          - walter.grey@example.com
          - walter.black@example.com
        createdAt: '2024-06-10T09:13:47.375Z'
        updatedAt: '2024-06-10T12:19:30.0Z'
      x-resolved-from: ../../devWebhookClients/openapi.yaml#/components/schemas/webhookClient
    abstractPagedBody:
      title: Abstract Paged Body (v0.5.1)
      x-apiture-version: 0.5.1
      description: An abstract schema used to define paginated collections of resources. Collection classes which extend this schema define an array of `items` which represent a page of data.
      x-apiture-fragment: true
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/abstractPagedBodyFields'
        - type: object
          properties:
            start:
              description: The opaque cursor that specifies the starting location of this page of items.
              type: string
              format: text
              maxLength: 256
      example:
        start: 1922a8531e8384cfa71b
        limit: 100
        nextPage_url: https://static.api.apiture.com/banking/resources?start=8b76b4a97dccad88890e&limit=100
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/abstractPagedBody
    webhookClientItem:
      x-apiture-version: 1.0.1
      title: Webhook Client Item (v1.0.1)
      description: An item in a list or collection of webhook clients.
      required:
        - id
        - description
        - environmentId
        - url
        - authorizationType
        - state
        - verified
      allOf:
        - $ref: '#/components/schemas/webhookClientFields'
      example:
        id: 0836e727e8d74a0fa5d83950
        environmentId: daafc39caac452708618a117
        state: active
        verified: true
        url: https://webhooks.example.com/fraud/live-monitoring
        description: My live fraud monitoring listener
        categories:
          - accounts
          - externalAccounts
          - authentication
          - entitlements
          - transfers
        authorizationType: oauthClientCredentials
      x-resolved-from: ../../devWebhookClients/openapi.yaml#/components/schemas/webhookClientItem
    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
    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
    webhookClientFields:
      x-apiture-version: 1.0.1
      title: Webhook Client Fields (v1.0.1)
      description: Fragment schema used to construct other webhook client schemas.
      x-apiture-fragment: true
      allOf:
        - $ref: '#/components/schemas/mutableWebhookClientFields'
        - $ref: '#/components/schemas/immutableWebhookClientFields'
      example:
        id: b8353f052227c0ca7627
        state: active
        verified: true
        description: My fraud monitoring webhook.
        url: https://webhooks.example.com/fraud/monitoring
        categories:
          - accounts
          - externalAccounts
          - authentication
          - entitlements
          - transfers
        authorizationType: basic
        owners:
          - walter.white@example.com
          - walter.grey@example.com
          - walter.black@example.com
      x-resolved-from: ../../devWebhookClients/openapi.yaml#/components/schemas/webhookClientFields
    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
    webhookClientBasicAuthorization:
      title: Webhook Client Basic Authorization (v1.0.0)
      description: 'The webhook authorization details with basic authentication. *Note*: For security reasons, the `password` is not returned in responses.'
      type: object
      required:
        - username
      allOf:
        - $ref: '#/components/schemas/webhookClientBasicAuthorizationFields'
      example:
        username: webhook-client-0123
        password: Z=<T$UgK#/RZxyJb1
      x-resolved-from: ../../devWebhookClients/openapi.yaml#/components/schemas/webhookClientBasicAuthorization
      x-apiture-version: 1.0.0
    webhookClientOAuthAuthorization:
      title: Webhook Client OAuth Authorization (v1.0.0)
      description: 'The webhook authorization details for OAuth2 client credentials grant flow. *Note*: For security reasons, the `clientSecret` is not returned in responses.'
      type: object
      required:
        - token_url
        - clientId
        - scope
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/webhookClientOAuthAuthorizationFields'
      example:
        token_url: https://www.example.com/auth/token
        clientId: 6f16b758-0b5e-4c4a-9746-c6d93dbda51b
        clientSecret: hEl4+89d%^/dP*@djZ=<T$UgK#/RZxyJb1
        scope: events/push
      x-resolved-from: ../../devWebhookClients/openapi.yaml#/components/schemas/webhookClientOAuthAuthorization
      x-apiture-version: 1.0.0
    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
    webhookClientId:
      x-apiture-version: 1.0.1
      title: Webhook Client Id (v1.0.1)
      description: The unique immutable, opaque identifier of a webhook client.
      allOf:
        - $ref: '#/components/schemas/resourceId'
      example: 510d681e-ff04-4e66-8b7f-e83973c867e9
      x-resolved-from: ../../devWebhookClients/openapi.yaml#/components/schemas/webhookClientId
    abstractPagedBodyFields:
      x-apiture-version: 1.1.1
      title: Abstract Paged Body Fields (v1.1.1)
      description: Common properties of collection page responses.
      x-apiture-fragment: true
      type: object
      required:
        - limit
      properties:
        limit:
          description: The number of items requested for this page response. The length of the `items` array may be less that `limit`.
          type: integer
          format: int32
          minimum: 0
          maximum: 10000
        nextPage_url:
          description: The URL of the next page of resources. If this URL is omitted, there are no more resources in the collection.
          readOnly: true
          maxLength: 8000
          type: string
          format: uri-reference
          example: https://static.api.apiture.com/banking/resources/8b76b4a97dccad88890e
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/abstractPagedBodyFields
    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
    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
    mutableWebhookClientFields:
      title: Mutable Webhook Client Fields (v1.0.0)
      description: Fields used to compose other webhook client schemas.
      x-apiture-fragment: true
      properties:
        description:
          type: string
          format: text
          description: The description of this webhook client.
          minLength: 10
          maxLength: 2048
          example: HOACorp Finco development component webhook
        url:
          type: string
          description: The webhooks URL where webhooks are sent via `POST`.
          example: https://webhooks.example.com/my-adb-listener
          format: uri
          pattern: ^https:\/\.*
          maxLength: 2048
        categories:
          type: array
          description: The categories of event types to send to the webhook.
          maxItems: 200
          uniqueItems: true
          items:
            $ref: '#/components/schemas/eventMessageCategory'
        owners:
          description: A list of people who are owners of this webhook client. Only owners may update (including modifying the list of owners) or delete a webhook client. The array elements are email addresses (normalized to lowercase).
          type: array
          items:
            type: string
            description: The email address of an owner. The owner must register and log in to the Apiture Developer Portal with this email address to enable owner actions. Use the [`inviteWebhookClientOwners`](#op-inviteWebhookClientOwners) to invite other owners. Owners may [`patch webhook client`](#op-patchWebhookClient) to remove owners.
            maxLength: 255
            format: email
          minItems: 1
          maxItems: 8
        authorizationType:
          $ref: '#/components/schemas/webhookClientAuthorizationType'
      example:
        description: My fraud monitoring webhook.
        url: https://webhooks.example.com/fraud/monitoring
        categories:
          - accounts
          - externalAccounts
          - authentication
          - entitlements
          - transfers
        authorizationType: basic
        owners:
          - walter.white@example.com
          - walter.grey@example.com
          - walter.black@example.com
      x-resolved-from: ../../devWebhookClients/openapi.yaml#/components/schemas/mutableWebhookClientFields
      x-apiture-version: 1.0.0
    immutableWebhookClientFields:
      x-apiture-version: 1.0.1
      title: Immutable Webhook Client Fields (v1.0.1)
      description: Fields used to compose other webhook client schemas.
      x-apiture-fragment: true
      allOf:
        - type: object
          properties:
            id:
              description: The opaque, immutable ID of this webhook client resource.
              $ref: '#/components/schemas/webhookClientId'
            environmentId:
              description: The ID of an API environment from which the the client receives event messages.
              $ref: '#/components/schemas/resourceId'
            state:
              $ref: '#/components/schemas/webhookClientState'
            verified:
              description: If `true`, the system has verified that the webhook `url` works. See the `verifyWebhookClient` operation in the Webhook Client Administration API.
              type: boolean
      example:
        id: b8353f052227c0ca7627
        environmentId: 66c4f3e301fbb635a249
        state: active
        verified: true
      x-resolved-from: ../../devWebhookClients/openapi.yaml#/components/schemas/immutableWebhookClientFields
    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)'
    webhookClientBasicAuthorizationFields:
      title: Webhook Client Basic Authorization Fields (v1.0.0)
      description: Webhook Client Basic Authorization Fields.
      type: object
      properties:
        username:
          type: string
          format: text
          maxLength: 48
          description: The HTTP Basic Authorization username.
        password:
          type: string
          format: text
          maxLength: 48
          description: The HTTP Basic authorization password.
      example:
        username: wh-client-0123
        password: Z=<T$UgK#/RZxyJb1
      x-resolved-from: ../../devWebhookClients/openapi.yaml#/components/schemas/webhookClientBasicAuthorizationFields
      x-apiture-version: 1.0.0
    webhookClientOAuthAuthorizationFields:
      title: Webhook Client OAuth Authorization Fields (v1.0.0)
      description: Webhook Client OAuth Authorization Fields.
      x-apiture-fragment: true
      properties:
        token_url:
          type: string
          format: uri
          maxLength: 2048
          description: The OAuth2 `token_endpoint`.
        clientId:
          type: string
          format: text
          maxLength: 100
          description: The OAuth2 Client ID.
        clientSecret:
          type: string
          description: The OAuth2 Client Secret.
          format: text
          maxLength: 100
        scope:
          type: string
          format: text
          maxLength: 100
          description: The OAuth2 scope.
      example:
        token_url: https://www.example.com/auth/token
        clientId: 6f16b758-0b5e-4c4a-9746-c6d93dbda51b
        clientSecret: hEl4+89d%^/dP*@djZ=<T$UgK#/RZxyJb1
        scope: events/push
      x-resolved-from: ../../devWebhookClients/openapi.yaml#/components/schemas/webhookClientOAuthAuthorizationFields
      x-apiture-version: 1.0.0
    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
    eventMessageCategory:
      x-apiture-version: 1.1.0
      title: Event Message Category (v1.1.0)
      description: An identifier for the category of the event. Multiple message types can belong to a category. This is a _lowerCamelCase_ string.
      type: string
      minLength: 4
      maxLength: 40
      pattern: ^[a-z][a-zA-Z0-9]{3,39}$
      example: wireTransfers
      x-resolved-from: ../../adminEvents/openapi.yaml#/components/schemas/eventMessageCategory
    webhookClientAuthorizationType:
      title: Webhook Client Authorization Type (v1.0.0)
      description: |+
        Indicates which type of authorization ADB must use when invoking the webhook

        <strong><code>webhookClientAuthorizationType</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>basic</code></strong></td><td>HTTP Basic Authorization: <p>Basic HTTP Authoriziation (encoded username and password)</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>oauthClientCredentials</code></strong></td><td>OAuth2 Client Credentials Authorization: <p>OAuth2 Client Credentials flow: Pass the encoded <code>clientId</code> and <code>clientSecret</code> to the <code>token_url</code> (OAuth2 <code>token_endpoint</code>) to obtain an access token and <code>token_type</code> (usually <code>Bearer</code>) and pass an <code>Authorization</code> header with the <code>token_type</code> and access token value</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: webhookClientAuthorizationType
      enum:
        - basic
        - oauthClientCredentials
      x-resolved-from: ../../devWebhookClients/openapi.yaml#/components/schemas/webhookClientAuthorizationType
      x-apiture-version: 1.0.0
    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:
    adminAccessToken:
      type: openIdConnect
      description: OpenId Connect (OIDC) authentication/authorization for an administrative user, such as financial institution staff or Apiture administrators. 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/adminAccessToken
  x-apiture-errors:
    invalidWebhookClientState:
      description: The requested operation is not allowed for a webhook in current state.
      remediation: Only invoke operations allowed for the given state.
    unprocessableEntity:
      description: The syntax of the request entity is correct but was unable to process the contained instructions.
      remediation: Provide a semantically correct request.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/unprocessableEntity
    invalidStart:
      description: The `start` query parameter is invalid.
      remediation: Use the `nextPage_url` in the previous response (and its service-generated `?start=` parameter) to access the next page
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/invalidStart
    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
    notFound:
      description: The resource at the requested URL does not exist.
      remediation: Use the URL of an existing resource.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/notFound
    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
  parameters:
    webhookClientIdPathParam:
      name: webhookClientId
      description: The `id` of the webhook client instance.
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/webhookClientId'
      x-resolved-from: ../../devWebhookClients/openapi.yaml#/components/parameters/webhookClientIdPathParam
x-resolved-from: ../../adminWebhookClients/status-codes-openapi.yaml
x-resolved-at: '2024-12-09T22:14:31.273Z'
x-apiture-annotated-at: '2024-12-09T22:14:31.524Z'
