openapi: 3.1.0
info:
  title: Partner Integration Definitions Administration
  description: |-
    This API allows Apiture Developer Portal (Dev Portal) administrators and manage partner _integration definitions_ submitted by Developer Portal users. An _integration definition_ defines a third party (fintech) integration into the Apiture Digital Banking platform. Initially, such integrations are for single-sign-on integrations (using SAML). This API allows administrators to review and approve/activate or reject integration definitions, or to deactivate integrations which Apiture or the financial institution suspects of fraudulent use or has a security risk or exposure.

    Like client applications, an owner of an integration definition can invite other owners.

    Owners may promote integration definitions (change from staged to live/active), disable them, and if there are no active instances, delete an integration definition.
  version: 0.4.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: adminIntegrationDefinitions
x-apiture-package-name: admin-integration-definitions
servers:
  - url: /devAdmin
tags:
  - name: Partner Integration Definitions
    description: Partner (Third Party) Integration Definitions
  - name: Partner Integration Definition Actions
    description: Actions on Integration Definitions
paths:
  /integrationDefinitions:
    get:
      summary: Return a collection of integrations
      description: Return a collection of integration definitions.
      operationId: listPartnerIntegrationDefinitions
      x-apiture-api: adminIntegrationDefinitions
      x-apiture-group: integrationDefinitionsAdmin
      tags:
        - Partner Integration Definitions
      security:
        - adminAccessToken:
            - adminIntegrationDefinitions/read
      parameters:
        - name: staged
          in: query
          description: Filter the response to only include integrations whose `staged` property matches this value.
          schema:
            type: boolean
        - name: partnerId
          in: query
          description: Filter the response to only include integrations whose `partnerId` matches the this value.
          schema:
            $ref: '#/components/schemas/resourceId'
        - name: institutionId
          in: query
          description: Filter the response to only include integrations whose `institutionId` matches the this value. When `availability` is not specifically filtered to return only definitions available to a `single` institution, definitions available to `all` institutions will also be returned.
          schema:
            $ref: '#/components/schemas/institutionId'
        - name: environmentId
          in: query
          description: Filter the response to only include integrations whose `environmentId` matches the this value.
          schema:
            $ref: '#/components/schemas/resourceId'
        - name: availability
          in: query
          description: Filter the response to only include integration definitions with the specified availability.
          style: pipeDelimited
          explode: false
          schema:
            type: array
            minItems: 1
            maxItems: 4
            uniqueItems: true
            items:
              type: string
              enum:
                - web
                - mobile
                - business
                - personal
                - singleInstitution
                - allInstitutions
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/integrationDefinitions'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
  /integrationDefinitions/{integrationDefinitionId}:
    parameters:
      - $ref: '#/components/parameters/integrationDefinitionIdPathParam'
    get:
      summary: Fetch a representation of this integration
      description: Return a representation of the integration definition.
      operationId: getPartnerIntegrationDefinition
      x-apiture-api: adminIntegrationDefinitions
      x-apiture-group: integrationDefinitionsAdmin
      tags:
        - Partner Integration Definitions
      security:
        - adminAccessToken:
            - adminIntegrationDefinitions/read
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/integrationDefinition'
        '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'
  /integrationDefinitions/{integrationDefinitionId}/inactive:
    parameters:
      - $ref: '#/components/parameters/integrationDefinitionIdPathParam'
    post:
      summary: Deactivate an integration definition.
      description: |-
        Mark a disabled integration definition as inactive. This allows Apiture (perhaps on behalf of the financial institution) to prevent new integrations being created from an integration definition, for example, if there is suspicion of fraud or a security vulnerability. This sets the `state` to `inactive`.

        Deactivated integration definitions are also unregistered in the System Integration Definitions API.

        Only `inactive`, `disabled`, or `active` integration definition may be deactivated. Inactive integration definition can be activated again (by and administrator) with the [`activatePartnerIntegrationDefinition`](#op-activatePartnerIntegrationDefinition).

        This operation is idempotent: it does nothing if the integration definition's `state` is already `inactive'.
      operationId: deactivatePartnerIntegrationDefinition
      x-apiture-api: adminIntegrationDefinitions
      x-apiture-group: integrationDefinitionsAdmin
      tags:
        - Partner Integration Definition Actions
      security:
        - adminAccessToken:
            - adminIntegrationDefinitions/write
      responses:
        '200':
          description: OK. The integration definition was marked as enabled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/integrationDefinition'
        '202':
          description: Accepted. The request to enabled an integration definition was accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/integrationDefinition'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409integrationDefinition'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
  /integrationDefinitions/{integrationDefinitionId}/active:
    parameters:
      - $ref: '#/components/parameters/integrationDefinitionIdPathParam'
    post:
      summary: Activate an integration definition.
      description: |-
        Mark an inactive or disabled integration definition as active. _Note_: Approving an integration definition is performed by activating a submitted integration definition. Only `submitted`, `inactive`, `disabled`, or `active` integration definition may be activated. This sets the `state` to `active` and also provisions the integration definition in the back end (using the System Integration Definitions API).
        This operation is idempotent: it does nothing if the integration definition's `state` is already `active'.
      operationId: activatePartnerIntegrationDefinition
      x-apiture-api: adminIntegrationDefinitions
      x-apiture-group: integrationDefinitionsAdmin
      tags:
        - Partner Integration Definition Actions
      security:
        - adminAccessToken:
            - adminIntegrationDefinitions/write
      responses:
        '200':
          description: OK. The integration definition was marked as activated and provisioned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/integrationDefinition'
        '202':
          description: Accepted. The request to activate and provision an integration definition was accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/integrationDefinition'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409integrationDefinition'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
  /integrationDefinitions/{integrationDefinitionId}/rejected:
    parameters:
      - $ref: '#/components/parameters/integrationDefinitionIdPathParam'
    post:
      summary: Reject an integration definition.
      description: |-
        Mark an inactive or disabled integration definition as rejected. Only `submitted`, `inactive`, `disabled`, or `rejected` integration definition may be marked as rejected. This sets the `state` to `rejected` and notifies the owners of the change.
        This operation is idempotent: it does nothing if the integration definition's `state` is already `rejected'.
      operationId: rejectPartnerIntegrationDefinition
      x-apiture-api: adminIntegrationDefinitions
      x-apiture-group: integrationDefinitionsAdmin
      tags:
        - Partner Integration Definition Actions
      security:
        - adminAccessToken:
            - adminIntegrationDefinitions/write
      responses:
        '200':
          description: OK. The integration definition was marked as rejected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/integrationDefinition'
        '202':
          description: Accepted. The request to reject an integration definition was accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/integrationDefinition'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409integrationDefinition'
        '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
    '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.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/unprocessableEntity'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/unprocessableEntity/v1.0.0
              title: Unprocessable Entity
              status: 422
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The request body and/or query parameters were well-formed but otherwise invalid.
              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/unprocessableEntity/v1.0.0
              title: Unprocessable Entity
              status: 422
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The request body and/or query parameters were well-formed but otherwise invalid.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/422
    '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
    409integrationDefinition:
      description: |
        Conflict.

        This problem response may have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/conflict/v1.0.0`](https://static.api.apiture.com/errors/conflict/v1.0.0)<br>
          The request could not be completed due to a conflict with the current state of the target resource.
          Remediation: Try another operation that is allowed.

        * [`https://static.api.apiture.com/errors/invalidIntegrationDefinitionState/v1.0.0`](https://static.api.apiture.com/errors/invalidIntegrationDefinitionState/v1.0.0)<br>
          The request is not allowed for an integration definition that is in the current state.
          Remediation: Ensure the integration definition is in a state that allows the requested operation.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/conflict'
        - invalidIntegrationDefinitionState
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
        application/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:
    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
    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
    integrationDefinitions:
      x-apiture-version: 3.0.0
      title: Integration definition collection (v3.0.0)
      description: Collection of integration definition items.
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          required:
            - items
          properties:
            items:
              description: An array containing integration summary items.
              type: array
              maxItems: 1000
              items:
                $ref: '#/components/schemas/integrationDefinitionItem'
      example:
        items:
          - id: ULTRA_PAY
            createdAt: '2021-10-30T19:06:04.250Z'
            updatedAt: '2021-10-30T19:06:04.250Z'
            partnerId: 3rdpartybank.com
            state: active
            staged: false
            activeInstanceCount: 14
            description: string
            availability:
              web: true
              mobile: true
              retail: true
              commercial: true
              institutions: single
            createdBy: fintechdev_01
            assertionEncryptionSupported: true
            serviceProviderMetadataUrl: https://my.audience.com/saml/metadata.xml
            serviceProviderHostsMetadata: true
      x-resolved-from: ../../devIntegrationDefinitions/openapi.yaml#/components/schemas/integrationDefinitions
    integrationDefinition:
      x-apiture-version: 4.0.0
      title: Integration Definition (v4.0.0)
      description: The definition of a third party integration.
      required:
        - id
        - description
        - staged
        - partnerId
        - availability
        - state
        - label
        - defaultRelayState
        - usesSpecificCustomerId
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/mutableIntegrationDefinitionFields'
        - $ref: '#/components/schemas/immutableIntegrationDefinitionFields'
        - type: object
          properties:
            id:
              $ref: '#/components/schemas/integrationDefinitionId'
            staged:
              type: boolean
              description: If `true`, the integration definition is staged for deployemnt but not live in production. If `false`, this is the live, deployed version of an integration definition.
            partnerId:
              description: Opaque partner identifier associated with the integration definition. The identifier is only used for logging and filtering purposes.
              $ref: '#/components/schemas/resourceId'
            code:
              title: Integration code
              description: TypeScript code to compute the SAML request assertion values from input data.
              type: string
              format: text
              maxLength: 102400
      example:
        id: FINTECH1_MODEL
        description: Fintech1 Financial Modeling Integration
        staged: false
        state: active
        activeInstanceCount: 14
        partnerId: 3rdpartybank.com
        availability:
          web: true
          mobile: true
          retail: true
          commercial: true
          institutions: single
        environmentId: 04833ea3-fbe0-43ac-95f8-188f59461ad5
        institutionId: TCF
        label: Fintech1 Financial Modeling
        mobileLabel: Fintech1 Financial Modeling
        usesSpecificCustomerId: true
        specificCustomerIdLabel: Customer Id
        specificCustomerIdDescription: Customer Id
        code: |-
          createSAMLRequest(user: UserData, param: Parameters, integration: Integration) {
            integration.assertions.add('answer', '42');
          }
        audienceUrl: https://my.audience.com/
        defaultRelayState: RelStat123
        signatureAlgorithm: RSA-SHA256
        digestAlgorithm: SHA256
        encryptionAlgorithm: AES256-GCM
        assertionEncryptionSupported: true
        serviceProviderMetadataUrl: https://my.audience.com/saml/metadata.xml
        serviceProviderHostsMetadata: true
        targetMethod: SAML-POST
        targetUrlTemplate: https://my-integration.example.com/sp/saml?cust=%7B%7BinstitutionId%7D%7D
        parameterSchema:
          type: object
          properties:
            value1:
              description: ...
              type: string
              format: text
              minLength: 1
              maxLength: 200
            value2:
              description: ...
              type: integer
              format: int32
              minimum: 1
              maximum: 100
            value3:
              description: ...
              type: string
              enum:
                - a
                - b
                - c
      x-resolved-from: ../../devIntegrationDefinitions/openapi.yaml#/components/schemas/integrationDefinition
    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
    integrationDefinitionItem:
      x-apiture-version: 3.0.0
      title: Integration Definition Item (v3.0.0)
      description: Integration definition item within collections/lists.
      type: object
      required:
        - id
        - staged
        - state
        - description
        - partnerId
        - serviceProviderHostsMetadata
        - createdBy
        - createdAt
      allOf:
        - $ref: '#/components/schemas/timestampFields'
        - $ref: '#/components/schemas/mutableIntegrationDefinitionFields'
        - $ref: '#/components/schemas/immutableIntegrationDefinitionFields'
        - properties:
            id:
              $ref: '#/components/schemas/integrationDefinitionId'
            staged:
              type: boolean
              description: If `true`, the integration definition is a staged for deployemnt. If `false`, this is the live, deployed version of an integration definition.
            description:
              description: The description of the client application.
              type: string
              format: text
              maxLength: 4000
            availability:
              description: Indicates if the integration definition can be used by any institution. or only one institution.
              $ref: '#/components/schemas/integrationDefinitionAvailability'
            partnerId:
              description: Opaque partner identifier associated with the integration definition. The identifier is only used for logging and filtering purposes.
              $ref: '#/components/schemas/resourceId'
            createdBy:
              description: Opaque identifier representing the partner user that created the integration definition. The identifier is only used for logging and filtering purposes.
              $ref: '#/components/schemas/resourceId'
      example:
        id: ULTRA_PAY
        description: Fintech1 SSO Integration
        createdAt: '2021-10-30T19:06:04.250Z'
        updatedAt: '2021-10-30T19:06:04.250Z'
        partnerId: 3rdpartybank.com
        state: active
        staged: false
        activeInstanceCount: 14
        availability:
          web: true
          mobile: true
          retail: true
          commercial: true
          institutions: single
        environmentId: 04833ea3-fbe0-43ac-95f8-188f59461ad5
        institutionId: TCF
        createdBy: fintechdev_01
        assertionEncryptionSupported: true
        serviceProviderMetadataUrl: https://my.audience.com/saml/metadata.xml
        serviceProviderHostsMetadata: true
      x-resolved-from: ../../devIntegrationDefinitions/openapi.yaml#/components/schemas/integrationDefinitionItem
    mutableIntegrationDefinitionFields:
      x-apiture-version: 3.0.0
      title: Mutable Integration Definition Fields (v3.0.0)
      description: Mutable Integration Definition fields used to compose other schemas.
      x-apiture-fragment: true
      type: object
      properties:
        description:
          description: The description of the client application.
          type: string
          format: text
          minLength: 4
          maxLength: 4000
        label:
          description: The label to be used in the online banking web client menu.
          type: string
          maxLength: 128
          minLength: 4
          format: text
        mobileLabel:
          description: The label to be used in the mobile banking application, if different from the `label`.
          type: string
          maxLength: 128
          minLength: 4
          format: text
        availability:
          $ref: '#/components/schemas/integrationDefinitionAvailability'
        audienceUrl:
          description: The audience URL for the SAML request.
          type: string
          format: uri
          maxLength: 255
        defaultRelayState:
          description: The default relay state for the SAML request.
          type: string
          format: text
          maxLength: 255
        signatureAlgorithm:
          description: The signature algorithm used for the SAML request. The value has to match one of the `signatureAlgorithms` returned by [`getSupportedIntegrationParameters`](#op-getSupportedIntegrationParameters).
          type: string
          maxLength: 15
          pattern: ^[-a-zA-Z0-9-_ ]{0,15}$
        digestAlgorithm:
          description: The digest / hash algorithm used for the SAML request. The value has to match one of the `digestAlgorithms` returned by [`getSupportedIntegrationParameters`](#op-getSupportedIntegrationParameters).
          type: string
          maxLength: 15
          pattern: ^[-a-zA-Z0-9-_ ]{0,15}$
        encryptionAlgorithm:
          description: The encryption algorithm used for the SAML request. The value has to match one of the `encryptionAlgorithms` returned by [`getSupportedIntegrationParameters`](#op-getSupportedIntegrationParameters).
          type: string
          maxLength: 15
          pattern: ^[-a-zA-Z0-9-_ ]{0,15}$
        assertionEncryptionSupported:
          description: '`true` if this integration supports assertion value encryption.'
          type: boolean
        serviceProviderHostsMetadata:
          description: If `true`, the SAML metadata at the `serviceProviderMetadataUrl` is hosted by the service provider. If `false`, the `serviceProviderMetadataUrl` represents a relative path.
          type: boolean
        serviceProviderMetadataUrl:
          description: The SAML Metadata URL for the service provider integration target. When `serviceProviderHostsMetadata` is `false`, this is assumed to point to an URL hosted by the Apiture platform provider,
          type: string
          format: uri-reference
          minLength: 1
          maxLength: 255
          example: https://auth.apiture.com/saml/sp/743d1fe4-f123-488e-9a20-1b5194bfa86c/metadata
        parameterSchema:
          description: JSON schema defining custom integration parameters required by the integration. The integration instance values for these parameters are configured in the financial institution admin application.
          $ref: '#/components/schemas/jsonObject'
        requiredProperties:
          description: Additional properties, separate from customer, institution, integration and environment properties, that this integration requires to be set. Each value has to match the `name` of one of the `additionalProperties` returned by [`getSupportedIntegrationParameters`](#op-getSupportedIntegrationParameters).
          type: array
          maxItems: 100
          items:
            $ref: '#/components/schemas/integrationPropertyName'
        usesSpecificCustomerId:
          description: If `true`, the integration uses an integration-specific customer identifier. A value for an integration-specific customer identifier has to be provided when defining an integration instance in the administation API.
          type: boolean
        specificCustomerIdLabel:
          description: Label for the integration-specific customer identifier shown in the financial institution admin application. when defining an integration instance in the administation API. Required if `usesSpecificCustomerId` is `true`.
          type: string
          format: text
          minLength: 1
          maxLength: 255
        specificCustomerIdDescription:
          description: Description for the integration-specific customer identifier when defining an integration instance in the administation API. Required if `usesSpecificCustomerId` is `true`.
          type: string
          format: text
          minLength: 1
          maxLength: 255
        targetUrlTemplate:
          description: The URL template to redirect or post to (depending on the `targetMethod`). The URL template string may contain one or more of the substitution variables `{{base64Saml}}`, `{{institutionId}}`, `{{configuration.<name>}}`,`{{vendorCustId}}`. The respective value(s) for the variable is replaced at runtime. For example, when the configuration for `vendorCustomerId` for an instance is set to `fin` in the financial institution admin application, The URL `https://{{configuration.vendorCustomerId}}.foo.com/` translates to `https://fin.foo.com/`.
          type: string
          format: uri
          minLength: 1
          maxLength: 255
        targetMethod:
          description: The method used to provide the data to the integration target. The value has to match one of the `targetMethods` returned by [`getSupportedIntegrationParameters`](#op-getSupportedIntegrationParameters).
          type: string
          minLength: 1
          maxLength: 15
          pattern: ^[-a-zA-Z0-9-_ ]{0,15}$
        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
      example:
        id: FINTECH1_MODEL
        description: Fintech1 Financial Modeling Integration
        staged: false
        state: active
        activeInstanceCount: 14
        label: Fintech1 SSO Integration
        mobileLabel: Fintech1 feature
        usesSpecificCustomerId: true
        specificCustomerIdLabel: Customer ID
        specificCustomerIdDescription: Unique Fintech1 Customer ID (GUID)
        availability:
          web: true
          mobile: true
          retail: true
          commercial: true
          institutions: single
        environmentId: 04833ea3-fbe0-43ac-95f8-188f59461ad5
        institutionId: TCF
        partnerId: 3rdpartybank.com
        code: |-
          createSAMLRequest(user: UserData, param: Parameters, integration: Integration) {
            integration.assertions.add('answer', '42');
          }
        audienceUrl: https://my.audience.com/
        defaultRelayState: RelStat123
        signatureAlgorithm: RSA-SHA256
        digestAlgorithm: SHA256
        encryptionAlgorithm: AES256-GCM
        assertionEncryptionSupported: true
        serviceProviderMetadataUrl: https://my.audience.com/saml/metadata.xml
        serviceProviderHostsMetadata: true
        targetMethod: SAML-POST
        targetUrlTemplate: https://my-integration.example.com/sp/saml?cust=%7B%7BinstitutionId%7D%7D
        parameterSchema:
          type: object
          properties:
            value1:
              description: ...
              type: string
              format: text
              minLength: 1
              maxLength: 200
            value2:
              description: ...
              type: integer
              format: int32
              minimum: 1
              maximum: 100
            value3:
              description: ...
              type: string
              enum:
                - a
                - b
                - c
        owners:
          - walter.white@example.com
          - walter.grey@example.com
          - walter.black@example.com
      x-resolved-from: ../../devIntegrationDefinitions/openapi.yaml#/components/schemas/mutableIntegrationDefinitionFields
    immutableIntegrationDefinitionFields:
      title: Immutable Integration Definition Fields (v1.0.0)
      description: Immutable Integration Definition Fields.
      x-apiture-fragment: true
      type: object
      allOf:
        - $ref: '#/components/schemas/timestampFields'
        - properties:
            partnerId:
              description: The unique ID of the partner who implements the integration.
              $ref: '#/components/schemas/resourceId'
            state:
              $ref: '#/components/schemas/partnerIntegrationDefinitionState'
            activeInstanceCount:
              type: integer
              minimum: 0
              maximum: 10000
              format: int32
              description: The number of active (not disabled) integration instances configured for this integration definition. Integration definitions that have an `activeInstanceCount` greater than 0 cannot be deleted.
            environmentId:
              description: The unique  identifier of the API Environment (financial institution and stage) where the integration is to be deployed. Only applicable if `availability.institutions` is `single`. The caller must have permission to deploy integrations in the environment.
              $ref: '#/components/schemas/resourceId'
            institutionId:
              description: The unique identifier of the financial institution the integration definition is executed for. The identifier is used for logging purposes. Only applicable if `availability.institutions` is `single`. This is derived from the `institutionId`.
              $ref: '#/components/schemas/institutionId'
      x-resolved-from: ../../devIntegrationDefinitions/openapi.yaml#/components/schemas/immutableIntegrationDefinitionFields
      x-apiture-version: 1.0.0
    integrationDefinitionId:
      title: Integration Definition Identifier (v1.0.0)
      description: The unique, human-readable identifier for the integration definition.
      type: string
      minLength: 2
      maxLength: 16
      pattern: ^[A-Z0-9_]{2,16}$
      example: ULTRA_PAY
      x-resolved-from: ../../devIntegrationDefinitions/openapi.yaml#/components/schemas/integrationDefinitionId
      x-apiture-version: 1.0.0
    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
    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
    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
    integrationDefinitionAvailability:
      x-apiture-version: 2.0.0
      title: Integration Definition Availability (v2.0.0)
      description: Defines the run-time contexts in which this integration is available.
      type: object
      required:
        - web
        - mobile
        - retail
        - commercial
        - institutions
      properties:
        web:
          description: The integration is available within the online banking (web) client application.
          type: boolean
        mobile:
          description: The integration is available within the mobile application.
          type: boolean
        retail:
          description: The integration is available to retail (personal) banking customers.
          type: boolean
        commercial:
          description: The integration is available to commercial (business and small business) customers.
          type: boolean
        institutions:
          $ref: '#/components/schemas/integrationDefinitionInstitutionAvailability'
      x-resolved-from: ../../devIntegrationDefinitions/openapi.yaml#/components/schemas/integrationDefinitionAvailability
    jsonObject:
      title: JSON Object (v1.0.0)
      description: A JSON object.
      type: object
      x-resolved-from: ../../devIntegrationDefinitions/openapi.yaml#/components/schemas/jsonObject
      x-apiture-version: 1.0.0
    integrationPropertyName:
      title: Integration Property Name (v1.0.0)
      description: The name of a data property that may be assigned in an integration.
      type: string
      pattern: ^[a-zA-Z][a-zA-Z0-9]{1,31}$
      minLength: 2
      maxLength: 32
      x-resolved-from: ../../devIntegrationDefinitions/openapi.yaml#/components/schemas/integrationPropertyName
      x-apiture-version: 1.0.0
    partnerIntegrationDefinitionState:
      title: Partner Integration Definition State (v1.0.0)
      description: |+
        The state of a partner's integration definition. The default state is `pending`. The definition state must be `active` before integration instances may be created from it.

        <strong><code>partnerIntegrationDefinitionState</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>pending</code></strong></td><td>Pending: <p>A new integration definition that has not been submitted, approved, or rejected.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>disabled</code></strong></td><td>Disabled: <p>Disabled by the integration definition owner. No new integration instances may be created until the owner enables the integration definition.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>rejected</code></strong></td><td>Rejected: <p>An integration definition that has been rejected by an administrator. Owners cannot change the state of a rejected integration definition.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>active</code></strong></td><td>Active: <p>The integration definition has been approved and is available for creating new integration instances.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>inactive</code></strong></td><td>Inactive: <p>An integration definition that has been marked as inactive by an administrator, for potential fraud, security, or other reasons. Owners cannot change the state of an inactive integration definition.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>submitted</code></strong></td><td>Submitted: <p>The integration definition has been submitted for Apiture and financial institution review.</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: partnerIntegrationDefinitionState
      enum:
        - pending
        - disabled
        - active
        - submitted
        - inactive
        - rejected
      x-resolved-from: ../../devIntegrationDefinitions/openapi.yaml#/components/schemas/partnerIntegrationDefinitionState
      x-apiture-version: 1.0.0
    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
    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
    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)'
    integrationDefinitionInstitutionAvailability:
      title: Integration Definition Visibility (v1.0.0)
      description: |+
        Integration Definition Visibility.

        <strong><code>integrationDefinitionInstitutionAvailability</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>single</code></strong></td><td>Single Institution: <p>The integration is only available to a single financial institution</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>all</code></strong></td><td>All Institutions: <p>The integration is available to all financial institutions</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: integrationDefinitionInstitutionAvailability
      enum:
        - single
        - all
      x-resolved-from: ../../systemIntegrationDefinitions/openapi.yaml#/components/schemas/integrationDefinitionInstitutionAvailability
      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
  x-apiture-errors:
    invalidIntegrationDefinitionState:
      description: The request is not allowed for an integration definition that is in the current state.
      remediation: Ensure the integration definition is in a state that allows the requested operation.
    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
    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
    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
    conflict:
      description: The request could not be completed due to a conflict with the current state of the target resource.
      remediation: Try another operation that is allowed.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/conflict
  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
  parameters:
    integrationDefinitionIdPathParam:
      name: integrationDefinitionId
      description: The integration identifier path parameter. This is a human-readable, but globally unique identifier.
      in: path
      schema:
        $ref: '#/components/schemas/integrationDefinitionId'
      required: true
      x-resolved-from: ../../devIntegrationDefinitions/openapi.yaml#/components/parameters/integrationDefinitionIdPathParam
x-apiture-traits:
  - state:
      name: integration definition
      verb: disable
      state: disabled
      etag: false
  - state:
      name: integration definition
      verb: enable
      state: active
      etag: false
x-resolved-from: ../../adminIntegrationDefinitions/status-codes-openapi.yaml
x-resolved-at: '2024-12-09T22:17:01.792Z'
x-apiture-annotated-at: '2024-12-09T22:17:02.035Z'
