openapi: 3.1.0
info:
  title: Account Applications Administration
  description: |-
    List and view customer's new account and join owner applications for administrative applications.

    * Use [`listCustomerAccountApplications`](#op-listCustomerAccountApplications) to list
      customer applications, with filters to select applications in date ranges, applications by
      type, by applicant or organization name, or by application state.
  version: 0.14.0
  contact:
    name: Apiture
    url: https://developer.apiture.com/help/support/
    email: api@apiture.com
  termsOfService: https://developer.apiture.com/docs/Apiture-API-License-Agreement.pdf
  license:
    name: Apiture API License
    url: https://developer.apiture.com/docs/Apiture-API-License-Agreement.pdf
x-apiture-namespace: bankingAdminAccountApplications
tags:
  - name: Customer Account Applications
    description: Customer Account Applications
  - name: Customer Account Application Actions
    description: Actions on Customer Account Applications
servers:
  - url: /bankingAdmin
paths:
  /customerAccountApplications:
    get:
      summary: Return a collection of customer account applications
      description: Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) collection of customer account applications. The [nextPage_url](https://developer.apiture.com/docs/concepts/links) in the response is a pagination link. The result is sorted in reverse chronological order.
      operationId: listCustomerAccountApplications
      x-apiture-api: bankingAdminAccountApplications
      x-apiture-group: customerAccountApplications
      tags:
        - Customer Account Applications
      parameters:
        - name: creationPeriod
          in: query
          description: Return only applications which have been created within this period of time before the present time. The value is an [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) string. For example, for `?creationPeriod=P1D` or `?creationPeriod=PT24H`, return applications created in the past day (24 hours). Use `?creationPeriod=P2W` to list applications created within the last 2 weeks. If the present time is 16:30PM, use `?creationPeriod=PT16H30M` to list all applications created since midnight, or `?creationPeriod=P1DT16H30M` to list all applications created since midnight yesterday. This parameter is mutually exclusive of `createdAt`.
          schema:
            type: string
            format: duration
            minLength: 3
            maxLength: 30
        - name: createdAt
          in: query
          description: 'Filter the response to only applications created in the date-time range bounded by _start_ and _end_ date-times. This parameter is mutually exclusive of `creationPeriod`. The _start_ and _end_ values are either dates in [RFC 3339](https://tools.ietf.org/html/rfc3339) `YYYY-MM-DD` date format, or date-times in `YYYY-MM-DDThh:mm:ss.sssZ` date-time format. <p> For example </p> <ul> <li>`[start,end]` between _start_ and _end_ date/times, inclusive of the endpoints</li> <li>`(start,end)` between _start_ and _end_ date/times, exclusive of the endpoints</li> <li>`(start,end]` between _start_ and _end_ date/times, exclusive of _start_ and inclusive of the _end_</li> <li>`[start,end)` between _start_ and _end_ date/times, inclusive of _start_ and exclusive of the _end_</li> <li>`YYYY-MM-DD` equivalent to `[start,end]`</li> </ul> <p> Dates without a time component are converted to UTC date-time values. If _start_ or _end_ are date values, then _start00_ is defined as time 00:00:00Z on the _start_ date, _start24_ is defined as 00:00AM of the day _after_ the _start_ date: _end00_ is defined as time 00:00:00Z on the _end_ date, _end24_ is defined as 00:00AM of the day _after_ the _end_ date: </p> <ul> <li>`[start,end]` is the same as `[start00,end24)`</li> <li>`(start,end]` is the same as `(start24,end24)`</li> <li>`[start,end)` is the same as `[start00,end00)`</li> <li>`(start,end)` is the same as `(start24,end00)`</li> </ul> <p> For example, the range `[2023-05-01,2023-06-01)` for events which occurred any day/time in May 2023 UTC is equivalent to `[2023-05-01T00:00:00.00Z,2023-06-01T00:00:00.00Z)`. </p> <p> If `start` is omitted, the range uses a value of 1 hour before the effective `end`. If `end` is omitted, the range uses a value of 1 hour after the effective `start`. </p> This parameter is mutually exclusive of `creationPeriod`.'
          schema:
            $ref: '#/components/schemas/dateTimeRange'
        - name: name
          in: query
          description: Return only applications whose applicant first name, applicant last name, or organization name matches this value or contains this value.
          schema:
            type: string
            format: text
            minLength: 2
            maxLength: 80
        - name: state
          in: query
          description: Return only applications whose `state` is in this list of states.
          style: pipeDelimited
          explode: false
          schema:
            type: array
            minItems: 1
            maxItems: 7
            uniqueItems: true
            items:
              $ref: '#/components/schemas/applicationState'
        - name: customerType
          description: Return only applications where the account's customer type matches this value.
          in: query
          schema:
            $ref: '#/components/schemas/applicationCustomerType'
        - $ref: '#/components/parameters/startQueryParam'
        - name: limit
          in: query
          description: The maximum number of items to return in this paged response.
          schema:
            type: integer
            format: int32
            minimum: 0
            maximum: 100
            default: 50
      security:
        - clientCredentials:
            - bankingAdmin/read
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customerAccountApplications'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/clientCredentials403'
        '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/creationDateTimeFilterConflict/v1.0.0`](https://static.api.apiture.com/errors/creationDateTimeFilterConflict/v1.0.0)<br>
              The `creationPeriod` and `createdAt` query parameters are mutually exclusive.
              Remediation: Pass only one of `creationPeriod` and `createdAt`.

            * [`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:
            - creationDateTimeFilterConflict
            - $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'
  /customerAccountApplications/{accountApplicationId}:
    parameters:
      - $ref: '#/components/parameters/accountApplicationIdPathParam'
    get:
      summary: Fetch a representation of this customer account application
      description: Return the JSON representation of this customer account application resource.
      operationId: getCustomerAccountApplication
      x-apiture-api: bankingAdminAccountApplications
      x-apiture-group: customerAccountApplications
      parameters:
        - name: unmasked
          description: |-
            When requesting an application, sensitive data like full account numbers and personally identifiable information (PII) are masked by default for security reasons. Include this query parameter with a value of `true` to request that the response body includes the unmasked data. Such requests are auditable.
            Passing `?unmasked=true` is equivalent to passing `?unmaskedFields=` with all allowed fields names.
            `unmasked` and `unmaskedFields` are mutually exclusive, and including both parameters in the request will result in error 422 `unmaskingParametersAreMutuallyExclusive`.
          in: query
          required: false
          schema:
            type: boolean
            default: false
        - name: unmaskedFields
          description: |-
            When requesting an application, sensitive data like full account numbers and personally identifiable information (PII) are masked by default for security reasons.
            Include this query parameter with a comma-separated list of the allowed property names to unmask those fields in the response. Such requests are auditable.
            `unmaskedFields` is similar to the `unmasked` query parameter except only the specified fields are returned unmasked in the response. Passing `?unmasked=true` is equivalent to passing `?unmaskedFields=` with all allowed field names.
            `unmasked` and `unmaskedFields` are mutually exclusive, and including both parameters in the request will result in error 422 `unmaskingParametersAreMutuallyExclusive`.
          in: query
          required: false
          style: form
          explode: false
          schema:
            type: array
            minItems: 1
            maxItems: 4
            x-apiture-note: The maximum number of items corresponds with the number of enum values in `adminApplicationMaskedProperties`
            uniqueItems: true
            items:
              $ref: '#/components/schemas/adminApplicationMaskedProperties'
      tags:
        - Customer Account Applications
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customerAccountApplication'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          description: Not Found. There is no such customer account application resource at the specified `{accountApplicationId}`.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/problemResponse'
        '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/unmaskingParametersAreMutuallyExclusive/v1.0.0`](https://static.api.apiture.com/errors/unmaskingParametersAreMutuallyExclusive/v1.0.0)<br>
              The `unmasked` and `unmaskedFields` query parameters are mutually exclusive.
              Remediation: Pass only one of `unmasked` and `unmaskedFields`.
          x-apiture-errors:
            - unmaskingParametersAreMutuallyExclusive
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/problemResponse'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
      security:
        - clientCredentials:
            - bankingAdmin/read
  /customerAccountApplications/{accountApplicationId}/resumed:
    parameters:
      - $ref: '#/components/parameters/accountApplicationIdPathParam'
    post:
      summary: Resume a stopped account application.
      description: |-
        Resume an account application that was in a "hard stop" state but which has been manually repaired.

        This operation is idempotent: it does nothing if the application state is already running.
      operationId: resumeStoppedCustomerAccountApplication
      x-apiture-api: bankingAdminAccountApplications
      x-apiture-group: customerAccountApplications
      tags:
        - Customer Account Application Actions
      parameters:
        - name: skipFailedTask
          in: query
          description: If `true`, the failed task is marked as completed and the application is resumed at the next available step. If `false` (or omitted), the failed task is restarted rather than skipped.
          schema:
            type: boolean
            default: false
      security:
        - adminAccessToken:
            - bankingAdmin/write
      responses:
        '200':
          description: OK. The account application was succesfully resumed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/customerAccountApplication'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          description: Not Found. There is no such customer account application resource at the specified `{accountApplicationId}`.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/problemResponse'
        '409':
          description: |
            Conflict. The request conflicts with the state of the system.

            This problem response may have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidStateForResume/v1.0.0`](https://static.api.apiture.com/errors/invalidStateForResume/v1.0.0)<br>
              The account application cannot be resumed due to other application data that requires repair.
              Remediation: Perform additional application repair.
          x-apiture-errors:
            - invalidStateForResume
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/problemResponse'
        '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/accountApplicationCannotBeResumed/v1.0.0`](https://static.api.apiture.com/errors/accountApplicationCannotBeResumed/v1.0.0)<br>
              The account application cannot be resumed. For example, resuming is not allowed if the applicant has canceled their application.
              Remediation: If possible, alter or repair the application. Remediation is not always possible.
          x-apiture-errors:
            - accountApplicationCannotBeResumed
          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'
components:
  parameters:
    accountApplicationIdPathParam:
      name: accountApplicationId
      description: The unique ID of a banking customer's account application. This is the `id` property of the application.
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/readOnlyResourceId'
    startQueryParam:
      name: start
      in: query
      description: The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the `?start=` parameter on the `nextPage_url`.
      schema:
        type: string
        maxLength: 256
        pattern: ^[-a-zA-Z0-9.,-=_+:;@$]{0,256}$
        default: ''
      x-resolved-from: ../../common/openapi.yaml#/components/parameters/startQueryParam
  schemas:
    customerAccountApplicationFields:
      x-apiture-version: 1.0.1
      title: Customer Account Application Fields (v1.0.1)
      description: Common fields of the customer account application resource used to build other model schemas.
      type: object
      x-apiture-fragment: true
      properties:
        assignee:
          description: Describes a financial institution operator or staff member that this application is assigned to. This property is omitted if the application is not assigned an operator.
          $ref: '#/components/schemas/applicationReviewerReference'
    customerAccountApplicationItem:
      x-apiture-version: 1.2.1
      title: Customer Account Application Item (v1.2.1)
      description: Summary representation of a customer account application resource in customer account applications collections. To fetch the full representation of this customer account application, use the [`getCustomerAccountApplication`](#op-getCustomerAccountApplication) operation, passing this item's `id` field as the `accountApplicationId` path parameter.
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/accountApplicationItemCommonFields'
        - $ref: '#/components/schemas/customerAccountApplicationFields'
        - type: object
          required:
            - id
            - applicant
            - approvals
          properties:
            id:
              description: The unique identifier for this customer account application resource. This is an immutable opaque string.
              allOf:
                - $ref: '#/components/schemas/readOnlyResourceId'
            applicant:
              description: The primary account applicant.
              $ref: '#/components/schemas/accountApplicantReference'
            organization:
              description: The business or organization that is the owner of the account. This is only present if corresponding banking product type is `business`.
              $ref: '#/components/schemas/applicationOrganizationReference'
            approvals:
              description: Any approvals associated with this application.
              type: array
              maxItems: 50
              items:
                $ref: '#/components/schemas/approval'
            createdAt:
              description: The date-time the application was created, in [RFC 3338](https://tools.ietf.org/html/rfc3339) date-time format, in UTC timezone.
              $ref: '#/components/schemas/readOnlyTimestamp'
      example:
        id: 0399abed-fd3d
        type: newAccount
        state: blocked
        createdAt: '2024-02-16T12:08:20.375Z'
        products:
          - type: cd
            target: business
            code: 180D_CDA
            label: 180-Day High Yield CD
        flaggedForReview: true
        hasUnresolvedProblems: true
        applicant:
          id: 6fed31a71850ae9b287d
          username: elsa_332
          firstName: Elsa
          lastName: Snowqueen
        approvals: []
        reviewer:
          id: ffc90da87392147f6832
          firstName: Sven
          lastName: Labrador
        assignee:
          id: ffc90da87392147f6832
          firstName: Sven
          lastName: Labrador
    customerRole:
      title: Customer Role (v1.0.0)
      description: Customer Role.
      type: object
      properties:
        name:
          description: The name (identifier) of the role, such as `primaryAccountHolder`.
          type: string
          format: text
          maxLength: 48
      x-apiture-version: 1.0.0
    customerAccountApplicant:
      x-apiture-version: 3.0.0
      title: Account Applicant (v3.0.0)
      description: An applicant for a new account.
      required:
        - username
        - contactCard
        - birthdate
        - attested
      type: object
      properties:
        id:
          description: The ADB customer ID of the applicant.
          type: string
          format: text
          readOnly: true
          maxLength: 48
        firstName:
          description: The applicant's first name.
          type: string
          format: text
          maxLength: 80
        lastName:
          description: The applicant's last name.
          type: string
          maxLength: 80
          format: text
        middleName:
          description: The applicant's middle name.
          type: string
          maxLength: 80
          format: text
        username:
          description: The unique login username for the applicant. If omitted on a request, this field will be set for the primary applicant, based on the username of the authenticated applicant that creates the application. This field is optional for co-owners and beneficial-owners.
          $ref: '#/components/schemas/customerUsername'
        contactCard:
          description: The contact information for the customer. Email addresses and phone numbers are masked unless the request uses `?unmasked=true`.
          $ref: '#/components/schemas/applicantContactCard'
        birthdate:
          description: The applicant's birth date in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) `date` format.
          type: string
          format: date
        taxId:
          description: The applicant's US social security number or individual taxpayer ID number (ITIN). The value is masked in responses (showing only one or more asterisks and the last four digits) unless the caller requests unmasked personally identifiable information (PII).
          type: string
          format: text
          minLength: 5
          maxLength: 16
        dueDiligenceAnswers:
          $ref: '#/components/schemas/applicantDueDiligenceAnswers'
        attested:
          description: If `true`, the applicant attested the information provided is true and accurate.
          type: boolean
        role:
          description: The role the applicant has relative to the account.
          $ref: '#/components/schemas/customerRole'
        verification:
          description: The verification status of the primary applicant.
          type: object
          allOf:
            - $ref: '#/components/schemas/applicantVerification'
      example:
        id: 6fed31a71850ae9b287d
        username: elsa_332
        firstName: Elsa
        lastName: Snowqueen
        attested: true
        taxId: '*1234'
        role:
          name: Primary Account Holder
        verification:
          provider: IDology
          sessionId: c97671fc-b658-4c15-a1c8-819e691b7d3c
          scoredAt: '2023-01-13T13:28:59.375Z'
          score: passed
          result: verified
          verifications:
            - type: fraudRiskReport
              state: passed
              createdAt: '2023-01-12T10:15:17Z'
            - type: quiz
              state: passed
              createdAt: '2023-01-12T10:19:41Z'
        contactCard:
          phoneNumbers:
            primary: '+19105551234'
            primaryExtension: '337'
          emailAddress: elsa.snowqueen@example.com
          addresses:
            primary:
              address1: 1805 Tiburon Dr.
              locality: Wilmington
              regionCode: NC
              countryCode: US
              postalCode: '28412'
            mailing:
              address1: P.O. Box 1805
              locality: Wilmington
              regionCode: NC
              countryCode: US
              postalCode: '28412'
            yearsAtPrimaryAddress: fourOrMore
        birthdate: '1995-01-30'
        dueDiligenceAnswers:
          bankingPurpose: operational funds
          citizen: true
          foreignPoliticalFigure: false
          familyOfPoliticalFigure: false
          w9Withholdings: false
          primaryIncomeSource: wages
          internationalTransfers: false
          identification:
            type: driversLicense
            number: '****1234'
            issuingAuthority: NC
            issuedOn: '2018-01-30'
            expiresOn: '2026-01-29'
          employment:
            status: fullTime
            currentEmployerName: Max Peck Towing
            occupation: businessAndFinancialOperations
            currentJobTitle: Chief Accountant
    customerAccountApplication:
      x-apiture-version: 4.0.0
      title: Customer Account Application (v4.0.0)
      description: Representation of a customer account application resource.
      required:
        - id
        - applicant
        - createdAt
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/accountApplicationItemCommonFields'
        - $ref: '#/components/schemas/accountApplicationCommonObjects'
        - $ref: '#/components/schemas/customerAccountApplicationFields'
        - type: object
          properties:
            id:
              description: The unique identifier for this customer account application resource. This is an immutable opaque string.
              allOf:
                - $ref: '#/components/schemas/readOnlyResourceId'
            applicant:
              description: The primary account applicant.
              $ref: '#/components/schemas/customerAccountApplicant'
            organization:
              description: The business or organization that is the owner of the account. This is only present if corresponding banking product type is `business`.
              $ref: '#/components/schemas/applicationOrganization'
            approvals:
              description: Any approvals associated with this application.
              type: array
              maxItems: 50
              items:
                $ref: '#/components/schemas/approval'
            funding:
              $ref: '#/components/schemas/accountApplicationFunding'
            debitCardRequest:
              $ref: '#/components/schemas/applicationDebitCardRequest'
            overdraftProtectionElections:
              description: Describes whether the applicant elected primary or secondary overdraft protection for the new account and when those elections were last updated.
              allOf:
                - $ref: '#/components/schemas/overdraftProtectionElections'
            notes:
              description: Any notes that operators/reviewers have attached to this application.
              type: array
              maxItems: 10000
              items:
                $ref: '#/components/schemas/adminNoteItem'
            createdAt:
              description: The date-time when the approval was created.
              $ref: '#/components/schemas/readOnlyTimestamp'
            updatedAt:
              description: The date-time when the application was last modified. This property is omitted if the application has not been modified since it was created.
              $ref: '#/components/schemas/readOnlyTimestamp'
            submittedAt:
              description: The date-time when the application was submitted. This property is omitted if the application has not been submitted.
              $ref: '#/components/schemas/readOnlyTimestamp'
            completedAt:
              description: The date-time when the application was completed. This property is omitted if the application has not been approved, rejected, canceled, or expired.
              $ref: '#/components/schemas/readOnlyTimestamp'
            trackingIds:
              description: An array of tracking IDs associated with the application.
              type: array
              maxItems: 150
              items:
                $ref: '#/components/schemas/resourceTrackingId'
      example:
        id: 0399abed-fd3d
        type: newAccount
        products:
          - type: cd
            target: business
            code: 180D_CDA
            label: 180-Day High Yield CD
        state: blocked
        flaggedForReview: true
        hasUnresolvedProblems: true
        updatedAt: '2023-01-13T13:28:59.375Z'
        applicant:
          id: 6fed31a71850ae9b287d
          username: elsa_332
          firstName: Elsa
          lastName: Snowqueen
          birthdate: '1995-01-30'
          role:
            name: Primary Account Holder
          verification:
            provider: IDology
            sessionId: c97671fc-b658-4c15-a1c8-819e691b7d3c
            scoredAt: '2023-01-13T13:28:59.375Z'
            score: passed
            result: verified
            verifications:
              - type: fraudRiskReport
                state: passed
                createdAt: '2023-01-12T10:15:17Z'
              - type: quiz
                state: passed
                createdAt: '2023-01-12T10:19:41Z'
          attested: true
          contactCard:
            phoneNumbers:
              primary: '+19105551234'
              primaryExtension: '337'
            emailAddress: elsa.snowqueen@example.com
            addresses:
              primary:
                address1: 1805 Tiburon Dr.
                locality: Wilmington
                regionCode: NC
                countryCode: US
                postalCode: '28412'
              mailing:
                address1: P.O. Box 1805
                locality: Wilmington
                regionCode: NC
                countryCode: US
                postalCode: '28412'
              yearsAtPrimaryAddress: fourOrMore
          dueDiligenceAnswers:
            bankingPurpose: operational funds
            citizen: true
            foreignPoliticalFigure: false
            familyOfPoliticalFigure: false
            w9Withholdings: false
            primaryIncomeSource: wages
            internationalTransfers: false
            identification:
              type: driversLicense
              number: '****1234'
              issuingAuthority: NC
              issuedOn: '2018-01-30'
              expiresOn: '2026-01-29'
            employment:
              status: fullTime
              currentEmployerName: Max Peck Towing
              occupation: businessAndFinancialOperations
              currentJobTitle: Chief Accountant
        organization:
          id: 638ae35cbe5b7e0baa40
          legalName: Max Peck Towing, LLC
          doingBusinessAs: Max Peck Towing
          taxId: 112-22-3333
          contactCard:
            addresses:
              primary:
                address1: 1805 Tiburon Dr.
                locality: Wilmington
                regionCode: NC
                countryCode: US
                postalCode: '28412'
              mailing:
                address1: P.O. Box 1805
                locality: Wilmington
                regionCode: NC
                countryCode: US
                postalCode: '28412'
            emailAddress: Max.Pike@example.com
            phoneNumbers:
              primary: '+19105550155'
            home_url: http://max-peck-towing.example.com
          approvals:
            - id: 0399abed-fd3d-4830-a88b-30f38b8a365c
              state: rejected
              done: true
              reason: Invalid U.S. Address
              createdAt: '2023-10-10T07:57:04.375Z'
              updatedAt: '2023-10-11T07:57:08.375Z'
              reviewedAt: '2023-10-12T07:57:13.375Z'
              target_url: https://static.api.apiture.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe
              approvalType:
                id: 0399abed-fd3d-4830-a88b-30f38b8a365c
                name: governmentId
                label: Government Issued ID
          industrySector: otherServices
          countryOfOperations: US
          registeredIn: NC
          employeeCountLowerBound: 1
          employeeCountUpperBound: 1
          estimatedAnnualRevenue: under1Million
          regulatory:
            atmOperator: false
            charity: false
            internetGambling: false
            marijuanaBusiness: false
            subjectToWithholdings: false
            intermediaryServices: []
          physicalLocationsCount: from10to50
          legalStructure: soleProprietorship
          estimatedMonthlyAmounts:
            achTransactions: oneHundredThousandToOneMillion
            mobileCheckDeposit: oneHundredThousandToOneMillion
            remoteCheckDeposit: oneHundredThousandToOneMillion
            wireTransfers: oneHundredThousandToOneMillion
          estimatedMonthlyCounts:
            achTransactions: oneHundredOneToOneThousand
            mobileCheckDeposit: oneHundredOneToOneThousand
            remoteCheckDeposit: oneHundredOneToOneThousand
            wireTransfers: oneToOneHundred
          beneficialOwners:
            - firstName: John
              middleName: Daniel
              lastName: Smith
              taxId: 112-22-3333
              percentage: 35
          updatedAt: '2023-10-24T06:26:53.375Z'
        approvals:
          - id: 0399abed-fd3d-4830-a88b-30f38b8a365c
            state: approved
            done: true
            createdAt: '2023-10-10T07:57:04.375Z'
            updatedAt: '2023-10-11T07:57:08.375Z'
            reviewedAt: '2023-10-12T07:57:13.375Z'
            target_url: https://static.api.apiture.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe/content
            approvalType:
              id: 0399abed-fd3d-4830-a88b-30f38b8a365c
              name: governmentId
              label: Government Issued ID
        reviewer:
          id: ffc90da87392147f6832
          firstName: Sven
          lastName: Labrador
        assignee:
          id: ffc90da87392147f6832
          firstName: Sven
          lastName: Labrador
        documents:
          - type: governmentId
            category: driversLicense
            contentType: application/pdf
            documentTarget: business
            uri: https://static.api.apiture.com/vault/7d0e5c70-6efd-4d7e-84c8-d62335227080/content
          - type: articlesOfOrganization
            contentType: application/pdf
            documentTarget: business
            category: articlesOfOrganization
            uri: https://static.api.apiture.com/vault/642c977e-4f24-4d7e-bccc-7e275fbfc415/content
        funding:
          maskedNumber: '*1234'
          routingNumber: '123123123'
          institutionName: Third Party Bank
          location: external
          type: checking
          verificationMethod: instant
          fundingAmount:
            value: '1000.00'
            currency: USD
          authorization:
            granted: true
            grantedAt: '2024-02-01T05:58:21.375Z'
            message: I, Phil Duciary, on 02/01/24 hereby authorize funds in the amount of $2,500 to be withdrawn as a ONE-TIME ACH DEBIT from my Third Party Bank checking account ending in 6789.
        overdraftProtectionElections:
          primary:
            election: true
            lastUpdatedAt: '2024-03-04T04:05:24.375Z'
          secondary:
            election: false
        debitCardRequest:
          cardholderName: John Smith
          requested: true
          shippingAddress:
            address1: P.O. Box 1805
            locality: Wilmington
            regionCode: NC
            countryCode: US
            postalCode: '28412'
        account:
          id: 98607305d7f7e28424c5
          name: My June CD
        createdAt: '2023-10-15T06:16:36.375Z'
        submittedAt: '2023-10-16T16:42:50.375Z'
        trackingIds:
          - id: 476824ec-7f8a-4909-bad7-b05ee26aba0f
            createdAt: '2021-06-07T09:11:02.375Z'
        notes:
          - id: 0399abed-fd3d
            text: Please review this fraud report.
            createdAt: '2023-04-19T10:49:28.375Z'
            creator:
              id: 0399abed-fd3d
              firstName: Benny
              lastName: Billings
              username: bbillings
              state: active
            attachments:
              - id: 0399abed-fd3d
                name: fraud-report-389398.pdf
                contentType: application/pdf
                url: https://cdn.apiture.com/admin-documents/fb45d9c8ce9980bc5e96.pdf
                contentLength: 276000
    customerAccountApplications:
      x-apiture-version: 1.2.1
      title: Customer Account Application Collection (v1.2.1)
      description: Collection of customer account applications. The items in the collection are ordered in the `items` array. The response object may contain the `nextPage_url` pagination link..
      allOf:
        - $ref: '#/components/schemas/abstractPagedBody'
        - type: object
          required:
            - items
          properties:
            items:
              description: An array containing a page of customer account application items.
              type: array
              maxItems: 10000
              items:
                $ref: '#/components/schemas/customerAccountApplicationItem'
      example:
        start: d1b48af913464aa49fcb07065dcc0616
        limit: 10
        nextPage_url: https://static.api.apiture.com/bankingAdmin/customerAccountApplications?start=6117a4dcefb841cab7316cef1ac8b58c&limit=10
        items:
          - id: 0399abed-fd3d
            type: newAccount
            state: blocked
            products:
              - type: cd
                target: business
                code: 180D_CDA
                label: 180-Day High Yield CD
            flaggedForReview: true
            hasUnresolvedProblems: true
            applicant:
              id: 97fd7e918b7ae6588b4b
              firstName: Elsa
              lastName: Snowqueen
            organization:
              id: 21ae7ee4af1e786f2be4
              legalName: Max Peck Mobile Repair
            account:
              id: 98607305d7f7e28424c5
              name: My June CD
            approvals: []
            reviewer:
              id: ffc90da87392147f6832
              firstName: Sven
              lastName: Labrador
            assignee:
              id: ffc90da87392147f6832
              firstName: Sven
              lastName: Labrador
    adminApplicationMaskedProperties:
      x-apiture-version: 1.0.0
      title: Application Administration Masked Properties (v1.0.0)
      description: |+
        The name of the property to return unmasked.

        <strong><code>adminApplicationMaskedProperties</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>applicantIdentification</code></strong></td><td>Applicant Identification: <p>The <code>taxId</code> field of the applicant.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>applicantGovernmentIssuedId</code></strong></td><td>Applicant Government-Issued Identification: <p>The <code>governmentIssuedId</code> <code>number</code> field on the applicant.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>beneficialOwnerGovernmentIssuedId</code></strong></td><td>Beneficial Owner Government-Issued Identification: <p>The <code>governmentIssuedId</code> <code>number</code> field on the application&#39;s beneficial owners.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>beneficialOwnerIdentification</code></strong></td><td>Beneficial Owner Identification: <p>The <code>taxId</code> field of a beneficial owner on the application.</p>
        </td>
            </tr>
        </table>

      x-apiture-enum: adminApplicationMaskedProperties
      type: string
      enum:
        - applicantIdentification
        - applicantGovernmentIssuedId
        - beneficialOwnerGovernmentIssuedId
        - beneficialOwnerIdentification
    dateTimeRange:
      title: Date Time Range (v1.0.0)
      description: |-
        A query parameter for selecting items in a date-time range. Filter the response to only items that fall in the range bounded by _start_ and _end_ date-times. The _start_ and _end_ values are either dates in [RFC 3339](https://tools.ietf.org/html/rfc3339) `YYYY-MM-DD` date format, or date-times in `YYYY-MM-DDThh:mm:ss.sssZ` date-time format.

        For example

           * `[start,end]` between _start_ and _end_ date/times, inclusive of the endpoints
           * `(start,end)` between _start_ and _end_ date/times, exclusive of the endpoints
           * `(start,end]` between _start_ and _end_ date/times, exclusive of _start_ and inclusive of the _end_
           * `[start,end)` between _start_ and _end_ date/times, inclusive of _start_ and exclusive of the _end_
           * `YYYY-MM-DD` equivalent to `[YYYY-MM-DD,YYYY-MM-DD]`

        Dates without a time component are converted to UTC date-time values. If _start_ or _end_ are date values, then _start00_ is defined as time 00:00:00Z on the _start_ date, _start24_ is defined as 00:00AM of the day _after_ the _start_ date: _end00_ is defined as time 00:00:00Z on the _end_ date, _end24_ is defined as 00:00AM of the day _after_ the _end_ date:

          * `[start,end]` is the same as `[start00,end24)`
          * `(start,end]` is the same as `(start24,end24)`
          * `[start,end)` is the same as `[start00,end00)`
          * `(start,end)` is the same as `(start24,end00)`

        For example, the range `[2023-05-01,2023-06-01)` matches any day/time in May 2023 and is equivalent to `[2023-05-01T00:00:00.00Z,2023-06-01T00:00:00.00Z)`.
      type: string
      format: text
      pattern: ^((\d{4}-\d{2}-\d{2})|([[(](((\d{4}-\d{2}-\d{2}([Tt]\d{2}:\d{2}:\d{2}(.\d{1,6})?[Zz])?),(\d{4}-\d{2}-\d{2}([Tt]\d{2}:\d{2}:\d{2}(.\d{1,6})?[Zz])?)?)|(,(\d{4}-\d{2}-\d{2}([Tt]\d{2}:\d{2}:\d{2}(.\d{1,6})?[Zz])?)))[)\]]))$
      minLength: 10
      maxLength: 63
      examples:
        - '[2023-04-28T00:00:00Z,]'
        - '[2023-04-28,2023-04-30]'
        - '[2023-04-28T10:10:10.10Z,2023-04-28T10:10:10.10Z]'
        - '[,2023-04-28T10:10:10.10Z]'
        - (2023-04-28T10:10:10.10Z,2023-04-28T20:20:10.10Z)
        - (2023-04-28T10:10:10.10Z,2023-04-28)
        - '[2023-04-28,2023-04-28T20:20:10.10Z)'
        - (2023-04-28T10:10:10.10Z,2023-04-28T20:20:10.10Z]
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/dateTimeRange
      x-apiture-version: 1.0.0
    applicationState:
      title: Application State (v1.0.0)
      description: |+
        The state of the enrollment or application.

        <strong><code>applicationState</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>Available to be started. This state is reserved for future use.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>running</code></strong></td><td>Running: <p>Started and has not completed or been canceled.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>blocked</code></strong></td><td>Blocked: <p>Started but is blocked; there are no available workflow tasks.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>canceled</code></strong></td><td>Canceled: <p>Canceled prior to completion.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>expired</code></strong></td><td>Expired: <p>Not completed prior to a pre-defined application life cycle term. For example, the FI may set a rule that all applications open longer than 30 days and not completed must be set to expired.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>rejected</code></strong></td><td>Rejected: <p>Completed but was rejected after review.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>approved</code></strong></td><td>Approved: <p>Completed and approved.</p>
        </td>
            </tr>
        </table>

      x-apiture-enum: applicationState
      type: string
      enum:
        - pending
        - running
        - blocked
        - canceled
        - expired
        - rejected
        - approved
      example: approved
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicationState
      x-apiture-version: 1.0.0
    applicationCustomerType:
      title: Application Customer Type (v1.0.0)
      description: Indicates the customer type for the account being applied for, either `personal` (retail) or `business` (commercial).
      type: string
      enum:
        - personal
        - business
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicationCustomerType
      x-apiture-version: 1.0.0
    problemResponse:
      title: Problem Response (v0.4.1)
      x-apiture-version: 0.4.1
      description: API problem or error response, as per [RFC 9457 application/problem+json](https://tools.ietf.org/html/rfc9457).
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/apiProblem'
      example:
        id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
        type: https://static.api.apiture.com/errors/noSuchAccount/v1.0.0
        title: Account Not Found
        status: 422
        occurredAt: '2022-04-25T12:42:21.375Z'
        detail: No account exists for the given account reference
        instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/problemResponse
    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
    applicationReviewerReference:
      title: Application Reviewer Reference (v1.0.0)
      description: Describes a financial institution operator or staff member (or system) which reviewed an account application.
      type: object
      required:
        - id
        - firstName
        - lastName
      properties:
        id:
          description: The id of the operator that reviewed the approval. This is the string `<system>` if the application was automatically approved or rejected without operator intervention.
          type: string
          format: text
          readOnly: true
          maxLength: 48
        firstName:
          description: The first name of the operator or other identity assigned to this case, if any. This is derived from the operator identified by `id`. This is the string `<system>` if the application was automatically approved or rejected without operator intervention.
          type: string
          format: text
          minLength: 1
          maxLength: 80
        lastName:
          description: The last name of the operator or other identity assigned to this case, if any. This is derived from the operator identified by `id`. This is the string `<system>` if the application was automatically approved or rejected without operator intervention.
          type: string
          format: text
          minLength: 1
          maxLength: 80
      example:
        id: ffc90da873-92147f6832
        firstName: Sven
        lastName: Labrador
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicationReviewerReference
      x-apiture-version: 1.0.0
    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
    accountApplicationItemCommonFields:
      x-apiture-version: 1.1.0
      title: Account Application Fields (v1.1.0)
      description: Common fields of the account application resource used to build other model schemas.
      x-apiture-fragment: true
      type: object
      required:
        - type
        - state
        - flaggedForReview
        - hasUnresolvedProblems
      properties:
        type:
          $ref: '#/components/schemas/applicationType'
        state:
          description: |
            The state of the application. The value is updated by the various application action operations.
          allOf:
            - $ref: '#/components/schemas/applicationState'
          readOnly: true
          example: running
        products:
          description: The list of banking products to be opened by this application. Present only if `type` is `newAccount`.
          type: array
          minItems: 1
          maxItems: 8
          items:
            $ref: '#/components/schemas/applicationProductReference'
        account:
          $ref: '#/components/schemas/applicationAccountReference'
        flaggedForReview:
          description: '`true` if the application is blocked awaiting review from the financial institution. This is derived from the state and approvals of the application, and is immutable.'
          type: boolean
          readOnly: true
          example: false
        hasUnresolvedProblems:
          description: '`true` if the application has at least one unresolved problem. This is derived from the list of problems tied to the application and is immutable.'
          type: boolean
          example: false
        reviewer:
          description: The most recent operator assigned to review this application. This field is omitted if no reviewed is assigned.
          $ref: '#/components/schemas/applicationReviewerReference'
      example:
        type: newAccount
        state: blocked
        products:
          - type: cd
            target: business
            code: 180D_CDA
            label: 180-Day High Yield CD
        flaggedForReview: true
        hasUnresolvedProblems: true
        reviewer:
          id: ffc90da87392147f6832
          firstName: Sven
          lastName: Labrador
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/accountApplicationItemCommonFields
    accountApplicantReference:
      x-apiture-version: 1.1.0
      title: Account Applicant Reference (v1.1.0)
      description: Describes the person who is applying for an account.
      type: object
      required:
        - id
        - firstName
        - lastName
      properties:
        id:
          description: The ADB customer ID of the applicant.
          type: string
          format: text
          readOnly: true
          maxLength: 48
        firstName:
          description: The first name of the applicant.
          type: string
          minLength: 1
          maxLength: 128
          format: text
        middleName:
          description: The middle name of the applicant.
          type: string
          minLength: 1
          maxLength: 80
          format: person-name
        lastName:
          description: The last name of the applicant.
          type: string
          x-apiture-note: 128 is from DAO Applications API. However, ADB customer full name (first + ' ' + last) is limited to 50 characters.
          minLength: 1
          maxLength: 128
          format: text
      example:
        id: 97fd7e918b7ae6588b4b
        firstName: Elsa
        middleName: Theresa
        lastName: Snowqueen
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/accountApplicantReference
    applicationOrganizationReference:
      title: Application Organization Reference (v1.0.0)
      description: A reference to an application organization.
      type: object
      allOf:
        - $ref: '#/components/schemas/organizationReferenceFields'
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicationOrganizationReference
      x-apiture-version: 1.0.0
    approval:
      title: Approval (v1.0.0)
      description: An approval represents the _review_ of some process, activity or resource, such as a document or an application. The state of the approval is recorded in its `state` property. The URL of the target of the approval is in the `target_url`.
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          properties:
            id:
              description: The unique identifier for this approval resource. This is an immutable opaque string.
              $ref: '#/components/schemas/readOnlyResourceId'
            state:
              description: The state of this approval. This property is derived and immutable.
              $comment: 'To add to description in future: Its value can only be changed by using the corresponding `POST` operations: `submitApproval`, `approveApproval`, `rejectApproval`, `waiveApproval`, `returnApproval`, and `cancelApproval`.'
              allOf:
                - $ref: '#/components/schemas/approvalState'
              readOnly: true
            target_url:
              description: |-
                The URL of the resource that this approval applies to, such as
                 a document an applicant has uploaded as part of an application.
              type: string
              format: url
              maxLength: 2048
            done:
              description: If `done` is true, the approval is in a terminal state and may no longer be acted upon.  Done states include `canceled`, `approved`, `waived` or `rejected`. This property is derived from the `state` field and is immutable.
              type: boolean
              readOnly: true
            reviewedBy:
              description: The unique operator ID of the operator that reviewed the approval. This is an operator resource ID, not the operator's login ID.
              $ref: '#/components/schemas/readOnlyResourceId'
            reason:
              description: The reason given for the last state change, such as why the approval was approved, rejected, waived, canceled, or returned.
              type: string
              format: text
              maxLength: 512
            createdAt:
              description: The approval's creation date-time, in [RFC 3339](https://tools.ietf.org/html/rfc3339) `YYYY-MM-DDThh:mm:ss.sssZ` format.
              $ref: '#/components/schemas/readOnlyTimestamp'
            updatedAt:
              description: The date-time of the approval's most recent update, in [RFC 3339](https://tools.ietf.org/html/rfc3339) `YYYY-MM-DDThh:mm:ss.sssZ` format.
              $ref: '#/components/schemas/readOnlyTimestamp'
            reviewedAt:
              description: The date-time when the approval was reviewed.
              $ref: '#/components/schemas/readOnlyTimestamp'
            approvalType:
              description: The type of this approval.
              allOf:
                - $ref: '#/components/schemas/approvalTypeItem'
      example:
        id: 0399abed-fd3d-4830-a88b-30f38b8a365c
        state: rejected
        done: true
        reason: Invalid U.S. Address
        createdAt: '2023-10-10T07:57:04.375Z'
        updatedAt: '2023-10-11T07:57:08.375Z'
        reviewedAt: '2023-10-12T07:57:13.375Z'
        target_url: https://static.api.apiture.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe
        approvalType:
          id: 0399abed-fd3d-4830-a88b-30f38b8a365c
          name: governmentId
          label: Government Issued ID
      x-resolved-from: ../../approvals/openapi.yaml#/components/schemas/approval
      x-apiture-version: 1.0.0
    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
    customerUsername:
      x-apiture-version: 2.0.0
      title: Customer Username (v2.0.0)
      description: A customer's login username.
      type: string
      format: text
      minLength: 5
      maxLength: 20
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/customerUsername
    applicantContactCard:
      x-apiture-version: 2.0.0
      title: Customer Contact Card (v2.0.0)
      description: A customer's contact information.
      type: object
      required:
        - addresses
        - emailAddress
        - phoneNumbers
      properties:
        suffix:
          description: A title or honorific suffix such as PhD or DDS.
          type: string
          maxLength: 20
          format: text
        addresses:
          description: The customer's postal addresses.
          $ref: '#/components/schemas/applicantAddresses'
        emailAddress:
          description: The customer's email address.
          $ref: '#/components/schemas/customerEmailAddress'
        phoneNumbers:
          description: The customer's phone numbers.
          $ref: '#/components/schemas/applicantPhoneNumbers'
      example:
        addresses:
          primary:
            address1: 1805 Tiburon Dr.
            locality: Wilmington
            regionCode: NC
            countryCode: US
            postalCode: '28412'
          mailing:
            address1: P.O. Box 1805
            locality: Wilmington
            regionCode: NC
            countryCode: US
            postalCode: '28412'
        emailAddress: Max.Pike@example.com
        phoneNumbers:
          primary: '+19105550155'
          primaryExtension: '347'
          mobile: '+19105550150'
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicantContactCard
    applicantDueDiligenceAnswers:
      x-apiture-version: 3.0.0
      title: Applicant Due Diligence Answers (v3.0.0)
      description: Answers the applicant provided for "Know Your Customer" due diligence questions which allow financial institutions to conform to their Customer Identification Program. Some financial institutions may choose to not collect all of these answers.
      type: object
      properties:
        bankingPurpose:
          description: A reason the user gave for banking with the financial institution. This applies to all accounts they intend to open under this customer relationship.
          type: string
          minLength: 2
          maxLength: 100
          format: text
          example: other
        otherBankingPurpose:
          description: A reason the user gave for banking with the financial institution if they selected `other` for `bankingPurpose`. This applies to all accounts they intend to open under this customer relationship.
          type: string
          minLength: 2
          maxLength: 100
          format: text
          example: rental escrow account
        citizen:
          description: '`true` if this person is a US citizen.'
          type: boolean
        usResident:
          description: If `citizen` is false, this property indicates the applicant's US residency status.
          $ref: '#/components/schemas/nonCitizenApplicant'
        w9Withholdings:
          description: '`true` if this person is a subject to backup W-9 Tax Withholdings.'
          type: boolean
        foreignPoliticalFigure:
          title: Foreign Senior Political Figure
          description: '`true` if this person is a foreign senior political figure.'
          type: boolean
          default: false
        foreignPoliticalFigureCountry:
          title: Foreign Senior Political Country
          description: If this person is a foreign senior political figure, this is the foreign country's [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. This field is omitted if `foreignPoliticalFigure` is `false`.
          type: string
          minLength: 2
          maxLength: 2
          pattern: '[A-Z][A-Z]'
          example: GB
        foreignPoliticalFigurePosition:
          title: Foreign Senior Political Position
          description: If this person is foreign senior political figure, this is the position that figure holds in the foreign country. This field is omitted if `foreignPoliticalFigure` is `false`.
          type: string
          minLength: 2
          maxLength: 100
          format: text
          example: Member of Parliament
        familyOfPoliticalFigure:
          title: Family or Associate of Political Figure
          description: '`true` if this person is an immediate family member or a close associate of a foreign senior political figure.'
          type: boolean
        familyOfPoliticalFigureCountry:
          title: Family or Associate of Political Figure Country
          description: If this person is an immediate family member or a close associate of political figure, this is the foreign country's [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. This field is omitted if `familyOfPoliticalFigure` is `false`.
          type: string
          minLength: 2
          maxLength: 2
          pattern: ^[A-Z][A-Z]$
          example: GB
        foreignPoliticalFigureAssociation:
          title: Association with Foreign Senior Political Figure
          description: If `familyOfPoliticalFigureCountry` is `true`, this is the type of association to the foreign senior political figure. This field is omitted if `familyOfPoliticalFigure` is `false`.
          allOf:
            - $ref: '#/components/schemas/foreignPoliticalFigureAssociation'
          example: closeAssociate
        foreignPoliticalFigureAssociationPosition:
          title: Foreign Senior Political Association Position
          description: If this person is an immediate family member or a close associate of a foreign senior political figure, this is the position that figure holds in the foreign country. This field is omitted if `familyOfPoliticalFigure` is `false`.
          type: string
          minLength: 2
          maxLength: 100
          format: text
          example: Member of Parliament
        primaryIncomeSource:
          description: The applicant's primary source of income.
          type: string
          format: text
          maxLength: 40
        otherPrimaryIncomeSource:
          description: The actual source if income if `primaryIncomeSource` is `other`.
          type: string
          minLength: 2
          maxLength: 100
          format: text
          example: spouse
        internationalTransfers:
          description: If `true`, the user affirmed they plan to use accounts at this financial institution to send or receive funds from foreign countries.
          type: boolean
        internationalTransferCountries:
          description: If `internationalTransfers` is `true`, this is the list of country names. This field is omitted if `internationalTransfers` is `false`.
          type: string
          minLength: 4
          maxLength: 500
          format: text
          example: Great Britain, France, Germany, Spain, Mexico
        identification:
          $ref: '#/components/schemas/applicantIdentification'
        employment:
          $ref: '#/components/schemas/applicantEmployment'
      example:
        bankingPurpose: operational funds
        citizen: true
        foreignPoliticalFigure: false
        familyOfPoliticalFigure: false
        w9Withholdings: false
        primaryIncomeSource: wages
        internationalTransfers: false
        identification:
          type: driversLicense
          number: '****1234'
          issuingAuthority: NC
          issuedOn: '2018-01-30'
          expiresOn: '2026-01-29'
        employment:
          status: fullTime
          currentEmployerName: Max Peck Towing
          occupation: businessAndFinancialOperations
          currentJobTitle: Chief Accountant
          previousOccupation: businessAndFinancialOperations
          currentEmploymentStartedOn: '2019-08-24'
          currentEmployerAddresses:
            address1: 1805 Tiburon Dr.
            address2: Building 14, Suite 1500
            locality: Wilmington
            regionCode: NC
            countryCode: US
            postalCode: '28403'
          currentEmployerPhoneNumber: '+19105550155'
          previousEmployerName: Tom's Wrecker Service
          previousJobTitle: Staff Accountant
          previousEmploymentStartedOn: '2016-04-04'
          previousEmploymentEndedOn: '2019-08-24'
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicantDueDiligenceAnswers
    applicantVerification:
      title: Applicant Identity Verification Data (v1.0.0)
      description: Results of identity verification process that tells if an applicant has passed or failed the identity check or if the verification expired.
      type: object
      properties:
        verifications:
          description: The history of this contact's identity verifications.
          type: array
          maxItems: 32
          items:
            $ref: '#/components/schemas/applicantIdentityHistoryItem'
          readOnly: true
        provider:
          description: The name of the identity verification provider.
          readOnly: true
          type: string
          format: text
          maxLength: 32
        sessionId:
          description: The unique ID for the identity verification process.
          readOnly: true
          type: string
          format: text
          maxLength: 512
        scoredAt:
          description: The date-time when the provider ran identity verification. This is an [RFC 3339](https://tools.ietf.org/html/rfc3339) time stamp.
          $ref: '#/components/schemas/readOnlyTimestamp'
        score:
          description: The indication if the user has passed or failed the identity verification process.
          $ref: '#/components/schemas/applicantIdentityVerificationState'
        result:
          title: Verification Result
          description: The identity verification status for this person.  This field is read-only and is derived from the results of any identity verification processes executed against the personally identifiable information (PII) in the associated user.
          allOf:
            - $ref: '#/components/schemas/applicantIdentityVerificationResult'
          readOnly: true
      example:
        provider: IDology
        sessionId: c97671fc-b658-4c15-a1c8-819e691b7d3c
        scoredAt: '2023-01-13T13:28:59.375Z'
        score: passed
        result: verified
        verifications:
          - type: fraudRiskReport
            state: passed
            createdAt: '2023-01-12T10:15:17Z'
          - type: quiz
            state: passed
            createdAt: '2023-01-12T10:19:41Z'
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicantVerification
      x-apiture-version: 1.0.0
    accountApplicationCommonObjects:
      title: Account Application Common Objects (v2.0.0)
      x-apiture-fragment: true
      description: Objects common to application resources. This is a fragment schema used to compose other schemas.
      x-apiture-version: 2.0.0
      properties:
        applicationDocuments:
          description: An array of metadata describing one or more documents which the applicant may need to provide during the application process. These can be applicant identity verification forms, such as a government ID, a tax ID, a utility bill, articles of organization (for business accounts), etc.
          type: array
          maxItems: 16
          items:
            $ref: '#/components/schemas/accountApplicationDocument'
        documents:
          description: An array of metadata listing zero or more documents which the FI reviewer must review and approve. These can be applicant identity verification forms, such as a government ID, a tax ID, a utility bill, articles of organization (for business accounts), etc. The items in this array match with the `requiredDocuments` 1-to-1 and items may be `null` if the user has not yet uploaded the corresponding required document.
          type: array
          maxItems: 16
          items:
            $ref: '#/components/schemas/applicationDocument'
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/accountApplicationCommonObjects
    applicationOrganization:
      x-apiture-version: 1.2.0
      title: Application Organization (v1.2.0)
      description: The business associated with a new business account application.
      type: object
      allOf:
        - $ref: '#/components/schemas/organizationFields'
        - type: object
          properties:
            approvals:
              description: Any approvals associated with this business.
              type: array
              maxItems: 50
              items:
                $ref: '#/components/schemas/approval'
            regulatory:
              $ref: '#/components/schemas/organizationRegulatory'
            estimatedMonthlyAmounts:
              description: Estimated monthly amounts for banking services.
              allOf:
                - $ref: '#/components/schemas/applicationMonthlyBankingServiceAmounts'
            estimatedMonthlyCounts:
              description: Estimated banking activity per month.
              allOf:
                - $ref: '#/components/schemas/applicationMonthlyBankingServiceCounts'
            estimatedAnnualRevenue:
              description: The range of estimated revenue in US dollars. This value is the name of a range, such as `from10to100Million`; these identifiers are defined by the financial institution.
              allOf:
                - $ref: '#/components/schemas/applicationOrganizationEstimatedAnnualRevenue'
            beneficialOwners:
              description: A list of people who own at least 25% of the business or who have a major role in the organization. The sum of the percentages may not exceed 100%. The percentage may be less than 25 for non-owners with a major role, or to retain other owners whose percentage may change to 25% in the future.
              type: array
              maxItems: 10
              items:
                $ref: '#/components/schemas/applicationBeneficialOwner'
            yearsOwned:
              $ref: '#/components/schemas/organizationYearsOwned'
            updatedAt:
              description: The date-time when the organization was updated
              $ref: '#/components/schemas/readOnlyTimestamp'
      example:
        id: 638ae35cbe5b7e0baa40
        legalName: Max Peck Towing, LLC
        doingBusinessAs: Max Peck Towing
        taxId: 112-22-3333
        yearsOwned: fourOrMoreYears
        contactCard:
          addresses:
            primary:
              address1: 1805 Tiburon Dr.
              locality: Wilmington
              regionCode: NC
              countryCode: US
              postalCode: '28412'
            mailing:
              address1: P.O. Box 1805
              locality: Wilmington
              regionCode: NC
              countryCode: US
              postalCode: '28412'
          emailAddress: Max.Pike@example.com
          phoneNumbers:
            primary: '+19105550155'
            primaryPhoneNumberExtension: '347'
          home_url: http://max-peck-towing.example.com
        approvals:
          - id: 0399abed-fd3d-4830-a88b-30f38b8a365c
            state: rejected
            done: true
            reason: Invalid U.S. Address
            createdAt: '2023-10-10T07:57:04.375Z'
            updatedAt: '2023-10-11T07:57:08.375Z'
            reviewedAt: '2023-10-12T07:57:13.375Z'
            target_url: https://static.api.apiture.com/vault/files/e4f09b4d-eba6-46da-86d3-hjr434fuhe
            approvalType:
              id: 0399abed-fd3d-4830-a88b-30f38b8a365c
              name: governmentId
              label: Government Issued ID
        industrySector: otherServices
        countryOfOperations: US
        registeredIn: NC
        employeeCountLowerBound: 1
        employeeCountUpperBound: 1
        estimatedAnnualRevenue: under1Million
        regulatory:
          atmOperator: false
          charity: false
          internetGambling: false
          marijuanaBusiness: false
          intermediaryServices: []
          subjectToWithholdings: false
        physicalLocationsCount: from10to50
        legalStructure: soleProprietorship
        estimatedMonthlyAmounts:
          achTransactions: oneHundredThousandToOneMillion
          mobileCheckDeposit: oneHundredThousandToOneMillion
          remoteCheckDeposit: oneHundredThousandToOneMillion
          wireTransfers: oneHundredThousandToOneMillion
        estimatedMonthlyCounts:
          achTransactions: oneHundredOneToOneThousand
          mobileCheckDeposit: oneHundredOneToOneThousand
          remoteCheckDeposit: oneHundredOneToOneThousand
          wireTransfers: oneToOneHundred
        beneficialOwners:
          - firstName: John
            middleName: Daniel
            lastName: Smith
            taxId: 112-22-3333
            percentage: 35
            governmentIssuedId:
              type: driverLicense
              number: '01234567'
              issuingAuthority: NC
              issuedOn: '2020-07-10'
              expiresOn: '2026-07-10'
        updatedAt: '2023-10-24T06:26:53.375Z'
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicationOrganization
    accountApplicationFunding:
      x-apiture-version: 1.4.0
      title: Account Application Funding (v1.4.0)
      description: Describes how the new account is funded.
      type: object
      properties:
        accountNumber:
          description: A full account number. This is the number that the customer uses to reference the account within the financial institution. This property is present only if the caller requests unmasked data.
          $ref: '#/components/schemas/fullAccountNumber'
        maskedNumber:
          $ref: '#/components/schemas/maskedAccountNumber'
        routingNumber:
          $ref: '#/components/schemas/accountRoutingNumber'
        institutionName:
          description: The name of the financial institution where the funding account is held.
          allOf:
            - $ref: '#/components/schemas/institutionName'
        location:
          $ref: '#/components/schemas/accountLocation'
        type:
          $ref: '#/components/schemas/productType'
        verificationMethod:
          $ref: '#/components/schemas/fundingAccountVerificationMethod'
        fundingAmount:
          description: How much money the applicant wishes to transfer from the funding account in order to initially fund this new account. This is optional and omitted in responses if not set when the application is created or updated.
          $ref: '#/components/schemas/money'
        authorization:
          description: The applicant's authorization for funding the new account.
          $ref: '#/components/schemas/accountApplicationFundingAuthorization'
      example:
        maskedNumber: '*1234'
        routingNumber: '123123123'
        institutionName: Third Party Bank
        location: external
        type: checking
        verificationMethod: instant
        fundingAmount:
          value: '1000.00'
          currency: USD
        authorization:
          granted: true
          grantedAt: '2024-02-01T05:58:21.375Z'
          message: I, Phil Duciary, on 02/01/24 hereby authorize funds in the amount of $2,500 to be withdrawn as a ONE-TIME ACH DEBIT from my Third Party Bank checking account ending in 6789.
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/accountApplicationFunding
    applicationDebitCardRequest:
      x-apiture-version: 1.0.1
      title: Application Debit Card Request (v1.0.1)
      description: Describes an optional request for a debit card to be issued for the new account.
      type: object
      properties:
        cardholderName:
          description: The name that will appear on the ordered debit card.
          example: John Smith
          type: string
          format: text
          maxLength: 80
        requested:
          description: Denotes if a debit card was ordered for a given account.
          example: true
          type: boolean
        shippingAddress:
          description: The user's shipping address where a debit card is to be sent.
          allOf:
            - $ref: '#/components/schemas/address'
      example:
        cardholderName: John Smith
        requested: true
        shippingAddress:
          address1: P.O. Box 1805
          locality: Wilmington
          regionCode: NC
          countryCode: US
          postalCode: '28412'
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicationDebitCardRequest
    overdraftProtectionElections:
      title: Overdraft Protection Elections (v1.0.0)
      description: Describes whether the account holder elected primary or secondary overdraft protection for the account and when those elections were last updated.
      type: object
      required:
        - primary
      properties:
        primary:
          description: Describes whether an account holder elected for the account to participate in the financial institution's primary overdraft protection plan.
          $ref: '#/components/schemas/overdraftProtectionElection'
        secondary:
          description: Describes whether an account holder elected for the account to participate in the financial institution's secondary overdraft protection plan. This value is only set if the financial institution offers a secondary overdraft protection plan.
          $ref: '#/components/schemas/overdraftProtectionElection'
      example:
        primary:
          election: true
          lastUpdatedAt: '2024-03-04T04:05:24.375Z'
        secondary:
          election: false
      x-resolved-from: ../../accounts/openapi.yaml#/components/schemas/overdraftProtectionElections
      x-apiture-version: 1.0.0
    adminNoteItem:
      x-apiture-version: 1.0.1
      title: Admin Note Item (v1.0.1)
      description: Summary representation of an admin note resource in admin notes collections. To fetch the full representation of this admin note, use the [`getAdminNote`](#op-getAdminNote) operation, passing this item's `id` field as the `adminNoteId` path parameter.
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/adminNoteFields'
        - $ref: '#/components/schemas/createdAtField'
        - type: object
          required:
            - id
            - text
            - creator
            - createdAt
          properties:
            id:
              description: The unique identifier for this admin note resource. This is an immutable opaque string.
              allOf:
                - $ref: '#/components/schemas/readOnlyResourceId'
            creator:
              description: Who created this note.
              allOf:
                - $ref: '#/components/schemas/adminUserReference'
            attachments:
              description: Optional description of files attached to this note. This property is omitted if there are no attachments. Use the [`getAdminNoteAttachment`](#op-getAdminNoteAttachment) with the attachment `id` to fetch its content.
              type: array
              maxItems: 8
              items:
                $ref: '#/components/schemas/adminNoteAttachmentItem'
      example:
        id: 0399abed-fd3d
        text: Please review this fraud report.
        createdAt: '2023-04-19T10:49:28.375Z'
        creator:
          id: 0399abed-fd3d
          firstName: Benny
          lastName: Billings
          username: bbillings
          state: active
        attachments:
          - id: 0399abed-fd3d
            name: fraud-report-389398.pdf
            contentType: application/pdf
            url: https://cdn.apiture.com/admin-documents/fb45d9c8ce9980bc5e96.pdf
            contentLength: 276000
      x-resolved-from: ../../adminNotes/openapi.yaml#/components/schemas/adminNoteItem
    resourceTrackingId:
      title: Resource Tracking Id (v1.0.0)
      description: A tracking ID for a resource. The ID is an opaque string which client applications associate with some other process or resource, such as a promotional campaign.
      type: object
      properties:
        id:
          description: The unique tracking ID string.
          $ref: '#/components/schemas/trackingId'
        createdAt:
          description: The date-time the tracking ID was added (if known) in [RFC 3338](https://tools.ietf.org/html/rfc3339) date-time format, in UTC timezone.
          $ref: '#/components/schemas/readOnlyTimestamp'
      example:
        id: 476824ec-7f8a-4909-bad7-b05ee26aba0f
        createdAt: '2021-06-07T09:11:02.375Z'
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/resourceTrackingId
      x-apiture-version: 1.0.0
    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
    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
    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
    applicationType:
      title: Application Type (v1.0.0)
      description: |+
        The type of an application.

        <strong><code>applicationType</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>newAccount</code></strong></td><td>New Account: <p>An application for a new banking account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>jointOwner</code></strong></td><td>Joint Owner: <p>An application to accept a joint owner invitation to an existing account</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: applicationType
      enum:
        - newAccount
        - jointOwner
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicationType
      x-apiture-version: 1.0.0
    applicationProductReference:
      x-apiture-version: 1.1.0
      title: Application Product Reference (v1.1.0)
      description: A reference to a banking product.
      type: object
      required:
        - type
        - target
        - code
        - label
      properties:
        type:
          description: The type of account.
          $ref: '#/components/schemas/productType'
        target:
          $ref: '#/components/schemas/productCustomerType'
        code:
          description: The product's product code which uniquely identifies the product from other banking products. Codes are unique to the financial institution. For example, different products with the same `type` and the same `coreType` but different rates or other properties have different product codes, such as `CD3M`, `DDA_HI_YLD`, `P3207`.
          type: string
          format: text
          minLength: 1
          maxLength: 16
        label:
          description: The human-readable label or name of this banking product.
          type: string
          minLength: 2
          maxLength: 48
          format: text
      example:
        type: cd
        target: business
        code: 180D_CDA
        label: 180-Day High Yield CD
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicationProductReference
    applicationAccountReference:
      title: Application Account Reference (v1.0.0)
      description: A reference to a banking account.
      type: object
      properties:
        id:
          description: The unique ID of the account resource, if known. This is not available until the application has been approved and completed and the account been created in the banking core.
          $ref: '#/components/schemas/readOnlyResourceId'
        name:
          description: The name (nickname) of new account. If omitted, the account label is derived from from the name of the product and masked account number.
          type: string
          format: text
          maxLength: 128
      example:
        id: 98607305d7f7e28424c5
        name: My June CD
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicationAccountReference
      x-apiture-version: 1.0.0
    organizationReferenceFields:
      x-apiture-version: 1.1.1
      title: Organization Reference Fields (v1.1.1)
      description: Fragment schema used to define other schemas.
      type: object
      required:
        - id
        - legalName
      x-apiture-fragment: true
      properties:
        id:
          description: The unique ID of this organization resource.
          $ref: '#/components/schemas/readOnlyResourceId'
        legalName:
          description: The company legal name.
          type: string
          format: text
          maxLength: 80
        doingBusinessAs:
          description: The company "doing business as" name.
          type: string
          format: text
          maxLength: 80
        taxId:
          description: The company tax identification number or Employer Identification Number (EIN).
          type: string
          format: text
          maxLength: 32
      x-resolved-from: ../../organizations/openapi.yaml#/components/schemas/organizationReferenceFields
    approvalState:
      title: Approval State (v1.0.0)
      description: |+
        The state of this approval.

        <strong><code>approvalState</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>open</code></strong></td><td>Open: <p>An approval that has been created but not submitted for review.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>submitted</code></strong></td><td>Submitted: <p>An approval that has been submitted for review but not yet reviewed.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>approved</code></strong></td><td>Approved: <p>An approval which has been approved by the financial institution.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>rejected</code></strong></td><td>Rejected: <p>An approval which has been rejected by the financial institution.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>waived</code></strong></td><td>Waived: <p>An approval which has been waived by the financial institution.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>returned</code></strong></td><td>Returned: <p>An approval which has been returned by the financial institution. The user should update the data that is the target of the review.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>canceled</code></strong></td><td>Canceled: <p>An approval which has been canceled by the user or the financial institution.</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: approvalState
      enum:
        - open
        - submitted
        - approved
        - rejected
        - waived
        - returned
        - canceled
      default: open
      x-resolved-from: ../../approvals/openapi.yaml#/components/schemas/approvalState
      x-apiture-version: 1.0.0
    approvalTypeItem:
      title: Approval Type Item (v1.0.0)
      description: Approval Type Item.
      required:
        - id
        - name
        - label
      type: object
      properties:
        id:
          description: The unique identifier for this approval type resource. This is an immutable opaque string.
          $ref: '#/components/schemas/readOnlyResourceId'
        name:
          description: The approval type's name. This is an identifier, such as `governmentId`
          type: string
          format: text
          maxLength: 64
        label:
          description: The approval type's common (human-readable) label.
          type: string
          format: text
          maxLength: 128
      example:
        id: a37edb797f43d74a5a73
        name: governmentId
        label: Government Issued ID
      x-resolved-from: ../../approvals/openapi.yaml#/components/schemas/approvalTypeItem
      x-apiture-version: 1.0.0
    applicantAddresses:
      title: Applicant Addresses (v1.0.0)
      description: An applicant's postal addresses.
      type: object
      properties:
        primary:
          description: The customer's primary address. For individuals, this is their home address. For businesses, this is the company's business address.
          $ref: '#/components/schemas/address'
        yearsAtPrimaryAddress:
          description: The number of years the customer has been at their present home address, as of the date the user registered. This value may become stale over time.
          allOf:
            - $ref: '#/components/schemas/yearsAtAddress'
        mailing:
          description: The customer's mailing address. If present, financial institution sends statements and other documents to this address instead of the `primary` address.
          $ref: '#/components/schemas/address'
        previous:
          description: The customer's previous address.
          $ref: '#/components/schemas/address'
      example:
        primary:
          address1: 1805 Tiburon Dr.
          locality: Wilmington
          regionCode: NC
          countryCode: US
          postalCode: '28412'
        mailing:
          address1: P.O. Box 1805
          locality: Wilmington
          regionCode: NC
          countryCode: US
          postalCode: '28412'
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicantAddresses
      x-apiture-version: 1.0.0
    customerEmailAddress:
      title: Customer Email Address (v1.0.0)
      description: A customer's single email address.
      type: string
      format: email
      maxLength: 255
      example: Max.Pike@example.com
      x-resolved-from: ../../customers/openapi.yaml#/components/schemas/customerEmailAddress
      x-apiture-version: 1.0.0
    applicantPhoneNumbers:
      title: Applicant Phone Numbers (v1.0.0)
      description: The applicant's phone numbers.
      allOf:
        - $ref: '#/components/schemas/customerPhoneNumbers'
        - type: object
          properties:
            primaryExtension:
              description: The phone number extension of the primary phone number.
              type: string
              pattern: ^[0-9]{1,8}$
              minLength: 1
              maxLength: 8
      example:
        primary: '+19105550155'
        primaryExtension: '347'
        mobile: '+19105550150'
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicantPhoneNumbers
      x-apiture-version: 1.0.0
    nonCitizenApplicant:
      title: Non-Citizen Applicant (v1.0.0)
      description: |
        Information about US residency and nationality of citizenship for applicants who are not US citizens.
      type: object
      required:
        - countryCode
        - type
      properties:
        countryCode:
          description: The ISO 3166-1 country code for the individual's citizenship or resident nationality. This is normalized to uppercase. The value is masked as `**` in responses unless the caller requests unmasked personally identifiable information (PII).
          x-apiture-pii: true
          type: string
          pattern: ^[a-zA-Z*]{2}$
          minLength: 2
          maxLength: 2
        type:
          description: The individual's citizenship status in the non-US country.
          x-apiture-pii: true
          type: string
          enum:
            - citizen
            - other
        usResidencyStatus:
          $ref: '#/components/schemas/applicantResidencyStatus'
      example:
        countryCode: GB
        type: citizen
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/nonCitizenApplicant
      x-apiture-version: 1.0.0
    foreignPoliticalFigureAssociation:
      title: Foreign Political Figure Association (v1.0.0)
      description: |+
        The type of association to a foreign political figure.

        <strong><code>foreignPoliticalFigureAssociation</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>unknown</code></strong></td><td>Unknown: <p>The association status of this individual is unknown.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>closeAssociate</code></strong></td><td>Close Associate: <p>This individual is a close associate of a foreign political figure.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>familyMember</code></strong></td><td>Family Member: <p>This individual is a family member of a foreign political figure.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>none</code></strong></td><td>None: <p>This individual has no association to a foreign political figure.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>other</code></strong></td><td>Other</td>
            </tr>
        <tr>
            <td><strong><code>notApplicable</code></strong></td><td>Not Applicable</td>
            </tr>
        </table>

      type: string
      enum:
        - unknown
        - closeAssociate
        - familyMember
        - none
        - other
        - notApplicable
      x-apiture-enum: foreignPoliticalFigureAssociation
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/foreignPoliticalFigureAssociation
      x-apiture-version: 1.0.0
    applicantIdentification:
      x-apiture-version: 1.0.1
      title: Applicant Identification (v1.0.1)
      description: Applicant Identification.
      type: object
      required:
        - type
        - number
      allOf:
        - $ref: '#/components/schemas/governmentIssuedIdFields'
        - type: object
          properties:
            residencyBeganOn:
              description: If the identification type is unexpired permanent residency card, this is the date when that residency began.
              $ref: '#/components/schemas/date'
            birthCountry:
              description: If the identification type is unexpired permanent residency card, this is the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the applicant's country of birth. The value is masked as `**` in responses unless the caller requests unmasked personally identifiable information (PII).
              type: string
              x-apiture-pii: true
              pattern: ^[a-zA-Z*]{2}$
              minLength: 2
              maxLength: 2
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicantIdentification
    applicantEmployment:
      x-apiture-version: 3.0.0
      title: Applicant Employment (v3.0.0)
      description: Applicant Employment.
      type: object
      required:
        - status
        - occupation
      properties:
        status:
          $ref: '#/components/schemas/applicantEmploymentStatus'
        occupation:
          description: An identifier naming the applicant's current occupation.
          allOf:
            - $ref: '#/components/schemas/occupationType'
        otherOccupation:
          description: The applicant's occupation if the `occupation` is `other`  (that is not in the list of occupations listed in [`occupationType`](#schema-occupationType)).
          type: string
          format: text
          minLength: 4
          maxLength: 191
        previousOccupation:
          description: The applicant's previous occupation, if any.
          type: string
          format: text
          minLength: 4
          maxLength: 191
        currentEmployerName:
          description: The name of the applicant's current employer. This property is only applicable if the `employmentStatus` indicates employment (including on leave).
          type: string
          format: text
          maxLength: 40
        currentEmploymentStartedOn:
          description: The date the applicant's employment with the current employer began, in [RFC 3339](https://tools.ietf.org/html/rfc3339) `date` format.
          allOf:
            - $ref: '#/components/schemas/date'
        currentEmployerAddresses:
          description: The address of the applicant's current employer.
          allOf:
            - $ref: '#/components/schemas/address'
        currentEmployerPhoneNumber:
          description: The phone number of the applicant's current employer.
          allOf:
            - $ref: '#/components/schemas/simplePhoneNumber'
        currentJobTitle:
          description: The applicant's current job title. This property is only applicable if the `employmentStatus` indicates employment (including on leave).
          type: string
          format: text
          maxLength: 80
        previousEmployerName:
          description: The name of the applicant's previous employer, if any.
          type: string
          format: text
          maxLength: 40
        previousJobTitle:
          description: The applicant's previous job title.
          type: string
          format: text
          maxLength: 80
        previousEmploymentStartedOn:
          description: The date the applicant's employment with their previous employer began, in [RFC 3339](https://tools.ietf.org/html/rfc3339) `date` format.
          allOf:
            - $ref: '#/components/schemas/date'
        previousEmploymentEndedOn:
          description: The date the applicant's employment with their previous employer ended, in [RFC 3339](https://tools.ietf.org/html/rfc3339) `date` format.
          allOf:
            - $ref: '#/components/schemas/date'
      example:
        status: fullTime
        occupation: computerAndMathematical
        previousOccupation: computerAndMathematical
        currentEmployerName: FutureSoft
        currentEmploymentStartedOn: '2019-08-24'
        currentEmployerAddresses:
          address1: 1805 Tiburon Dr.
          address2: Building 14, Suite 1500
          locality: Wilmington
          regionCode: NC
          countryCode: US
          postalCode: '28403'
        currentEmployerPhoneNumber: '+19105550155'
        currentJobTitle: Senior Software Engineer
        previousEmployerName: LegacySoft
        previousJobTitle: Junnior Software Engineer
        previousEmploymentStartedOn: '2016-04-04'
        previousEmploymentEndedOn: '2019-08-24'
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicantEmployment
    applicantIdentityHistoryItem:
      title: Applicant Identity Verification Item (v1.0.0)
      description: One verification record for an applicant's history of identity verifications.
      type: object
      required:
        - state
        - createdAt
      properties:
        state:
          $ref: '#/components/schemas/applicantIdentityVerificationState'
        type:
          $ref: '#/components/schemas/applicantIdentityVerificationType'
        createdAt:
          description: The date-time when the verification occurred or completed. This is an [RFC 3066](https://tools.ietf.org/html/rfc3339) time stamp in the form `YYYY-DD-MMThh:mm:ss.sssZ`.
          $ref: '#/components/schemas/readOnlyTimestamp'
        expiredAt:
          description: The date-time when the verification expired. This is only set if the `state` is `expired`. This is an [RFC 3066](https://tools.ietf.org/html/rfc3339) time stamp in the form `YYYY-DD-MMThh:mm:ss.sssZ`.
          $ref: '#/components/schemas/readOnlyTimestamp'
      example:
        state: passed
        createdAt: '2022-11-21T08:43:54.375Z'
        type: quiz
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicantIdentityHistoryItem
      x-apiture-version: 1.0.0
    applicantIdentityVerificationState:
      title: Applicant Identity Verification state (v1.0.0)
      description: |+
        The state of the applicant's historical identity verification.

        <strong><code>applicantIdentityVerificationState</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>passed</code></strong></td><td>Passed: <p>Identity verification passed.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>failed</code></strong></td><td>Failed: <p>Identity verification failed.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>passedWithRiskFactors</code></strong></td><td>PassedWithRiskFactors: <p>Identity verification passed with risk factors.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>underReview</code></strong></td><td>underReview: <p>Identity verification requires manual review.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>pending</code></strong></td><td>Pending: <p>Identity verification has not started.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>asked</code></strong></td><td>Asked: <p>Identity verification is in progress, after personal questions have been presented to the applicant.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>identityServiceFailure</code></strong></td><td>IdentityServiceFailure: <p>Identity verification failed to complete due to a failure in a back-end or third party service.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>scoring</code></strong></td><td>Scoring: <p>Identity verification is generating a verification score.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>expired</code></strong></td><td>Expired: <p>The applicant did not complete the identity verification process before it expired.</p>
        </td>
            </tr>
        </table>

      type: string
      enum:
        - passed
        - failed
        - passedWithRiskFactors
        - underReview
        - pending
        - asked
        - identityServiceFailure
        - scoring
        - expired
      x-apiture-enum: applicantIdentityVerificationState
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicantIdentityVerificationState
      x-apiture-version: 1.0.0
    applicantIdentityVerificationResult:
      title: Verification Result (v1.0.0)
      description: |+
        The identity verification status for this person.  This field is read-only and is derived from the results of any identity verification processes executed against the personally identifiable information (PII) contained in this record.

        <strong><code>applicantIdentityVerificationResult</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>unknown</code></strong></td><td>Unknown: <p>The applicant&#39;s identity verification result is unknown.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>verified</code></strong></td><td>Verified: <p>The applicant&#39;s identity has been verified (passed).</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>unverified</code></strong></td><td>Unverified: <p>The applicant&#39;s identity has not been verified (failed).</p>
        </td>
            </tr>
        </table>

      type: string
      readOnly: true
      enum:
        - unknown
        - verified
        - unverified
      x-apiture-enum: applicantIdentityVerificationResult
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicantIdentityVerificationResult
      x-apiture-version: 1.0.0
    accountApplicationDocument:
      title: Account Application Document (v1.0.0)
      description: A document which the financial institution may require the applicant to upload in conjunction with this account application.
      type: object
      allOf:
        - $ref: '#/components/schemas/applicationDocumentFields'
        - type: object
          properties:
            label:
              description: User friendly label of the document.
              type: string
              format: text
              maxLength: 120
            template_url:
              description: If present, the applicant must download the document template from this URL, fill out the document from the template, then upload that completed document.
              type: string
              format: uri
              maxLength: 2048
            required:
              description: If `true`, the financial institution requires the applicant to upload this document. This value is set based on the financial institution policies, business rules, and the data supplied as part of the application.
              type: boolean
      required:
        - label
        - type
        - documentTarget
        - category
        - required
      example:
        type: governmentId
        category: driversLicense
        label: Driver's License
        documentTarget: personal
        required: false
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/accountApplicationDocument
      x-apiture-version: 1.0.0
    applicationDocument:
      x-apiture-version: 1.1.2
      title: Application Document (v1.1.2)
      description: A document uploaded as part of the application process.
      type: object
      required:
        - uri
        - contentType
        - type
      allOf:
        - $ref: '#/components/schemas/applicationDocumentFields'
        - type: object
          properties:
            uri:
              description: The URL of the document applicant had uploaded.
              type: string
              format: uri
              maxLength: 2048
      example:
        category: driversLicense
        type: governmentId
        contentType: application/pdf
        documentTarget: personal
        uri: https://static.api.apiture.com/vault/7d0e5c70-6efd-4d7e-84c8-d62335227080/content
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicationDocument
    organizationFields:
      x-apiture-version: 1.2.0
      title: Organization Fields (v1.2.0)
      description: Fragment schema used to build other organization fields.
      type: object
      x-apiture-fragment: true
      allOf:
        - $ref: '#/components/schemas/organizationReferenceFields'
        - type: object
          properties:
            contactCard:
              $ref: '#/components/schemas/organizationContactCard'
            taxId:
              description: The tax identification number or Employer Identification Number (EIN) of the organization.
              type: string
              format: text
              minLength: 4
              maxLength: 32
            industrySector:
              description: The industry sector of this organization. This is an identifier, such as `financialServices`, `professionalServices`, `education`, `realEstate`, `vehicleSales`, or `other`. The sector names are defined by the financial institution.
              $ref: '#/components/schemas/lowerCamelCaseIdentifier40'
            countryOfOperations:
              type: string
              description: The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code for the organization's operation.
              minLength: 2
              maxLength: 2
              pattern: ^[a-zA-Z]{2}$
            registeredIn:
              description: The US state or other region in which the organization is registered.
              type: string
              example: NC
              minLength: 2
              maxLength: 2
              pattern: ^[a-zA-Z]{2}$
            employeeCountLowerBound:
              description: The lower bound of the numeric range of persons employed by the organization.
              type: integer
              format: int32
              minimum: 1
              maximum: 20000000
            employeeCountUpperBound:
              description: The upper bound of the numeric range of persons employed by the organization.
              type: number
              format: int32
              minimum: 1
              maximum: 20000000
            physicalLocationsCount:
              title: Physical Locations
              description: The number of physical sites, offices, or locations the organization owns, operates, or occupies. This is an identifier which defines a range of values, such as `from10to50` or `moreThan100`, as set by the financial institution.
              $ref: '#/components/schemas/lowerCamelCaseIdentifier40'
            legalStructure:
              description: The type of business or organization associated with the new account application. This is an identifier, such as `soleProprietorship`, `financialInstitution`, `corporation`, `unknown, or `other`. The names are defined by the financial institution.
              $ref: '#/components/schemas/lowerCamelCaseIdentifier64'
      x-resolved-from: ../../organizations/openapi.yaml#/components/schemas/organizationFields
    organizationRegulatory:
      title: Organization Regulatory (v1.0.0)
      description: Responses to regulatory-related questions about the business associated with a new account application.
      type: object
      required:
        - atmOperator
        - charity
        - internetGambling
        - marijuanaBusiness
        - subjectToWithholdings
      properties:
        atmOperator:
          description: The organization operates automated teller machines (ATMs).
          type: boolean
        charity:
          description: Some of the organization's income depends on a charity.
          type: boolean
        internetGambling:
          description: The organization derives income from internet gambling.
          type: boolean
        marijuanaBusiness:
          description: The organization derives income from marijuana or other drugs/controlled substances.
          type: boolean
        subjectToWithholdings:
          description: If `true`, the organization is subject to tax withholdings.
          type: boolean
          default: false
        intermediaryServices:
          description: A list of intermediary/non-bank financial institution services provided the organization performs on behalf of others.
          type: array
          maxItems: 21
          uniqueItems: true
          items:
            $ref: '#/components/schemas/organizationIntermediaryService'
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/organizationRegulatory
      x-apiture-version: 1.0.0
    applicationMonthlyBankingServiceAmounts:
      title: Estimated Monthly Banking Service Amounts (v1.0.0)
      description: Estimated monthly amounts for banking services.
      type: object
      properties:
        achTransactions:
          description: The estimated total amount sent or received by ACH per month. Use this or `sentAch`/`receivedAch`. This value is the name of a range as defined by the financial institution.
          type: string
          format: text
          maxLength: 40
          example: oneHundredThousandToOneMillion
        mobileCheckDeposit:
          description: The estimated amount deposited by mobile app per month. This value is the name of a range as defined by the financial institution.
          type: string
          format: text
          maxLength: 40
          example: oneHundredThousandToOneMillion
        remoteCheckDeposit:
          description: The estimated amount deposited remotely, via scanned images, per month. This value is the name of a range as defined by the financial institution.
          type: string
          format: text
          maxLength: 40
          example: oneHundredThousandToOneMillion
        wireTransfers:
          description: The estimated wire transfer amount sent or received per month. Use this or `sentWire`/`receivedWire`. This value is the name of a range as defined by the financial institution.
          type: string
          format: text
          maxLength: 40
          example: oneHundredThousandToOneMillion
      example:
        achTransactions: oneHundredThousandToOneMillion
        mobileCheckDeposit: oneHundredThousandToOneMillion
        remoteCheckDeposit: oneHundredThousandToOneMillion
        wireTransfers: oneHundredThousandToOneMillion
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicationMonthlyBankingServiceAmounts
      x-apiture-version: 1.0.0
    applicationMonthlyBankingServiceCounts:
      title: Estimated Monthly Banking Service Counts (v1.0.0)
      description: Estimated monthly activity for banking services.
      type: object
      properties:
        achTransactions:
          description: The estimated total number of ACH transactions per month. This value is the name of a range as defined by the financial institution.
          type: string
          format: text
          maxLength: 40
          example: oneHundredOneToOneThousand
        mobileCheckDeposit:
          description: The estimated number of mobile app deposits per month. This value is the name of a range as defined by the financial institution.
          type: string
          format: text
          maxLength: 40
          example: oneHundredOneToOneThousand
        remoteCheckDeposit:
          description: The estimated number of remote deposits (via scanned images) per month. This value is the name of a range as defined by the financial institution.
          type: string
          format: text
          maxLength: 40
          example: oneHundredOneToOneThousand
        wireTransfers:
          description: The estimated number of wire transfers sent or received per month. This value is the name of a range as defined by the financial institution.
          type: string
          format: text
          maxLength: 40
          example: oneToOneHundred
      example:
        achTransactions: oneHundredOneToOneThousand
        mobileCheckDeposit: oneHundredOneToOneThousand
        remoteCheckDeposit: oneHundredOneToOneThousand
        wireTransfers: oneToOneHundred
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicationMonthlyBankingServiceCounts
      x-apiture-version: 1.0.0
    applicationOrganizationEstimatedAnnualRevenue:
      title: Estimated Annual Revenue (v1.0.0)
      description: The estimated annual revenue in US dollars.
      type: string
      enum:
        - unknown
        - under1Million
        - from1to10Million
        - from10to100Million
        - over100Million
        - other
        - notApplicable
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicationOrganizationEstimatedAnnualRevenue
      x-apiture-version: 1.0.0
    applicationBeneficialOwner:
      x-apiture-version: 1.2.0
      title: Application Beneficial Owner (v1.2.0)
      description: A person who owns 25% or more of a business organization.
      required:
        - firstName
        - lastName
        - percentage
        - taxId
      type: object
      properties:
        prefix:
          description: A title or honorific prefix such as Dr. or Fr.
          type: string
          maxLength: 20
          format: person-name
        firstName:
          description: The beneficial owner's first name (or given name).
          type: string
          minLength: 0
          maxLength: 80
          format: text
        middleName:
          description: The beneficial owner's middle name.
          type: string
          minLength: 1
          maxLength: 80
          format: text
        lastName:
          description: The beneficial owner's last name (or surname).
          type: string
          minLength: 1
          maxLength: 80
          format: text
        suffix:
          description: A title or honorific suffix such as PhD or DDS.
          type: string
          maxLength: 20
          format: person-name
        role:
          description: The person's role at the organization.
          type: string
          maxLength: 80
          format: text
        birthdate:
          description: The beneficial owner's birth date in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) `date` format. The value is masked (some or all digits replaced with an asterisk `'*'`) in responses unless the caller requests unmasked personally identifiable information (PII).
          type: string
          format: text
          minLength: 10
          maxLength: 10
          pattern: ^[0-9*]{4}-[0-9*]{2}-[0-9*]{2}$
        taxId:
          description: The beneficial owner's US social security number or individual taxpayer ID number (ITIN). The value is masked in responses (showing only one or more asterisks and the last four digits) unless the caller requests unmasked personally identifiable information (PII).
          type: string
          format: text
          minLength: 5
          maxLength: 16
        governmentIssuedId:
          description: A secondary form of government issued identification for the beneficial owner.
          $ref: '#/components/schemas/beneficialOwnerGovernmentIssuedId'
        percentage:
          description: The percent of the business that this person owns.
          type: number
          format: float
          minimum: 0
          maximum: 100
          example: 25
        address:
          description: The beneficial owner's primary address.
          $ref: '#/components/schemas/address'
        emailAddress:
          description: The beneficial owner's email address, such as `JohnBankCustomer@example.com`
          type: string
          format: email
          minLength: 8
          maxLength: 255
          example: JohnBankCustomer@example.com
        phoneNumber:
          description: The beneficial owner's phone number.
          $ref: '#/components/schemas/simplePhoneNumber'
        identityVerificationStatus:
          description: The identity verification status for this beneficial owner. This field is read-only and is derived from the results of any Identity API verification applied to this beneficial owner's personally identifiable information (PII).
          readOnly: true
          allOf:
            - $ref: '#/components/schemas/applicantIdentityVerificationResult'
      example:
        firstName: John
        middleName: Daniel
        lastName: Smith
        taxId: 112-22-3333
        percentage: 35
        governmentIssuedId:
          type: driversLicense
          number: '01234567'
          issuingAuthority: NC
          issuedOn: '2020-07-10'
          expiresOn: '2026-07-10'
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicationBeneficialOwner
    organizationYearsOwned:
      title: Organization Years Owned (v1.0.0)
      description: The range of years the owners/operators have owned the business.
      type: string
      enum:
        - unknown
        - one
        - two
        - three
        - fourOrMoreYears
        - other
        - notApplicable
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/organizationYearsOwned
      x-apiture-version: 1.0.0
    fullAccountNumber:
      title: Full Account Number (v1.0.0)
      description: A full account number. This is the number that the customer uses to reference the account within the financial institution.
      type: string
      minLength: 1
      maxLength: 32
      pattern: ^[- a-zA-Z0-9.]{1,32}$
      examples:
        - '123456789'
      x-resolved-from: ../../accounts/openapi.yaml#/components/schemas/fullAccountNumber
      x-apiture-version: 1.0.0
    maskedAccountNumber:
      x-apiture-version: 1.0.1
      title: Masked Account Number (v1.0.1)
      description: 'A masked account number: an asterisk `*` followed by one to four characters of the `fullAccountNumber`.'
      type: string
      minLength: 2
      maxLength: 5
      pattern: ^\*[- _a-zA-Z0-9.]{1,4}$
      examples:
        - '*1008'
        - '*0005'
      x-resolved-from: ../../accounts/openapi.yaml#/components/schemas/maskedAccountNumber
    accountRoutingNumber:
      title: Account Routing Number (v1.0.0)
      description: An account ABA routing and transit number.
      type: string
      minLength: 9
      maxLength: 9
      pattern: ^[0-9]{9}$
      example: '123123123'
      x-resolved-from: ../../accounts/openapi.yaml#/components/schemas/accountRoutingNumber
      x-apiture-version: 1.0.0
    institutionName:
      title: Institution Name (v1.0.0)
      description: A financial institution's name.
      type: string
      format: text
      minLength: 2
      maxLength: 128
      x-resolved-from: ../../institutions/openapi.yaml#/components/schemas/institutionName
      x-apiture-version: 1.0.0
    accountLocation:
      x-apiture-version: 1.1.0
      title: Account Location (v1.1.0)
      description: |+
        Indicates where an account is held

        <strong><code>accountLocation</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>internal</code></strong></td><td>Internal: <p>Accounts held by the banking customer at the current financial institution</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>external</code></strong></td><td>External: <p>Accounts held by the banking customer at another financial institution</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>outside</code></strong></td><td>Outside: <p>Non-banking accounts such as brokerage and fund accounts.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>peer</code></strong></td><td>Peer: <p>Accounts held by others at the same financial institution, for which the banking customer has transfer to and/or transfer from entitlements.</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: accountLocation
      enum:
        - internal
        - external
        - outside
        - peer
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/accountLocation
    productType:
      x-apiture-version: 2.2.0
      title: Product Type (v2.2.0)
      description: |+
        The type (or category) of banking product.

        <strong><code>productType</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>savings</code></strong></td><td>Savings: <p>Savings Account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>checking</code></strong></td><td>Checking: <p>Checking Account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>cd</code></strong></td><td>CD: <p>Certificate of Deposit Account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>ira</code></strong></td><td>IRA: <p>Individual Retirement Account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>loan</code></strong></td><td>Loan: <p>Loan Account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>creditCard</code></strong></td><td>Credit Card: <p>Credit Card Account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>moneyMarket</code></strong></td><td>Money Market: <p>Money Market Account</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>healthSavings</code></strong></td><td>Health Savings: <p>Health Savings Account</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: productType
      enum:
        - savings
        - checking
        - cd
        - ira
        - loan
        - creditCard
        - moneyMarket
        - healthSavings
      x-resolved-from: ../../products/openapi.yaml#/components/schemas/productType
    fundingAccountVerificationMethod:
      title: Account Verification Method (v1.0.0)
      description: 'Indicates how an external account was verified: micro deposits or IAV (Instant Account Verification).'
      type: string
      enum:
        - instant
        - microDeposit
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/fundingAccountVerificationMethod
      x-apiture-version: 1.0.0
    money:
      x-apiture-version: 1.0.2
      title: Money (v1.0.2)
      description: An amount of money in a specific currency.
      type: object
      properties:
        value:
          description: The net monetary value. A negative amount denotes a debit; a positive amount denotes a credit. The numeric value is represented as a string so that it can be exact with no loss of precision.
          $ref: '#/components/schemas/monetaryValue'
        currency:
          description: The [ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) for this monetary value.
          $ref: '#/components/schemas/currencyCode'
      example:
        value: '1000.00'
        currency: USD
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/money
    accountApplicationFundingAuthorization:
      title: Account Application Funding Authorization (v1.0.0)
      description: The applicant's authorization for funding the new account.
      type: object
      required:
        - granted
      properties:
        granted:
          type: boolean
          description: '`true` if and only if the user has explicitly granted funding authorization.'
        grantedAt:
          description: The date and time the user granted the funding authorization. Present only if `granted` is `true`.
          $ref: '#/components/schemas/readOnlyTimestamp'
        message:
          description: The message presented to the user when they granted the funding authorization. Present only if `granted` is `true`.
          type: string
          maxLength: 1000
          format: text
      example:
        granted: true
        grantedAt: '2024-02-01T05:58:21.375Z'
        message: I, Phil Duciary, on 02/01/24 hereby authorize funds in the amount of $2,500 to be withdrawn as a ONE-TIME ACH DEBIT from my Third Party Bank checking account ending in 6789.
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/accountApplicationFundingAuthorization
      x-apiture-version: 1.0.0
    address:
      x-apiture-version: 1.6.1
      title: Address (v1.6.1)
      description: A postal address that can hold a US address or an international (non-US) postal addresses.
      type: object
      required:
        - address1
        - locality
        - postalCode
        - countryCode
      allOf:
        - $ref: '#/components/schemas/fullAddressFields'
      examples:
        - address1: 1805 Tiburon Dr.
          address2: Building 14, Suite 1500
          locality: Wilmington
          regionCode: NC
          countryCode: US
          postalCode: '28403'
        - address1: 999 Canada Place
          locality: Vancouver
          regionName: British Columbia
          countryCode: CA
          postalCode: V6C 3T4
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/address
    overdraftProtectionElection:
      title: Overdraft Protection Election (v1.0.0)
      description: Overdraft Protection Election. Describes whether an account holder has elected for an overdraft protection plan for this account or not, and when that election was last updated.
      type: object
      required:
        - election
      properties:
        election:
          description: If `true`, an account holder has elected to enable an overdraft protection plan for this account. `false` if the account holder has never set an election option or if the last change was to opt out of the plan.
          type: boolean
        lastUpdatedAt:
          description: The date and time when an account holder last changed the overdraft protection plan election. This property is omitted if an account holder has not yet changed the election for this plan.
          $ref: '#/components/schemas/readOnlyTimestamp'
      example:
        election: true
        lastUpdatedAt: '2024-03-04T04:05:24.375Z'
      x-resolved-from: ../../accounts/openapi.yaml#/components/schemas/overdraftProtectionElection
      x-apiture-version: 1.0.0
    adminNoteFields:
      title: Admin Note Fields (v1.0.0)
      description: Common fields of the admin note resource used to build other model schemas.
      type: object
      x-apiture-fragment: true
      properties:
        text:
          description: The text of this note.
          type: string
          format: text
          minLength: 2
          maxLength: 400
      x-resolved-from: ../../adminNotes/openapi.yaml#/components/schemas/adminNoteFields
      x-apiture-version: 1.0.0
    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)'
    adminUserReference:
      title: Admin User Reference (v1.0.0)
      description: A small object representing an administrative user's login account.
      type: object
      required:
        - id
        - firstName
        - lastName
        - username
        - state
      properties:
        id:
          description: The immutable, unique, opaque identifier for the user.
          $ref: '#/components/schemas/readOnlyResourceId'
        firstName:
          description: The user's first name.
          type: string
          format: text
          maxLength: 56
        lastName:
          description: The user's last name.
          type: string
          format: text
          maxLength: 56
        username:
          description: The user's login username.
          type: string
          format: text
          maxLength: 255
        state:
          $ref: '#/components/schemas/adminUserState'
      example:
        id: 0399abed-fd3d
        firstName: Benny
        lastName: Billings
        username: bbillings
        state: active
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/adminUserReference
      x-apiture-version: 1.0.0
    adminNoteAttachmentItem:
      title: Admin Note Attachment Item (v1.0.0)
      description: Summary representation of an admin note attachment in a list of admin note attachments.
      type: object
      allOf:
        - $ref: '#/components/schemas/adminNoteAttachmentFields'
        - type: object
          required:
            - id
            - name
            - contentType
            - url
            - contentLength
          properties:
            id:
              description: The unique identifier for this admin note attachment resource. This is an immutable opaque string.
              allOf:
                - $ref: '#/components/schemas/readOnlyResourceId'
            contentLength:
              description: The content length (size in bytes) of the attachment.
              type: integer
              format: int32
              readOnly: true
              minimum: 1
              maximum: 100000000
      example:
        id: 0399abed-fd3d
        name: fraud-report-389398.pdf
        contentType: application/pdf
        url: https://cdn.apiture.com/admin-documents/fb45d9c8ce9980bc5e96.pdf
        contentLength: 276000
      x-resolved-from: ../../adminNotes/openapi.yaml#/components/schemas/adminNoteAttachmentItem
      x-apiture-version: 1.0.0
    trackingId:
      x-apiture-version: 1.1.0
      description: A unique tracking ID string.
      type: string
      format: text
      minLength: 1
      maxLength: 256
      pattern: ^[-a-zA-Z0-9.,-~=_+:;@$]{1,256}$
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/trackingId
      title: ' (v1.1.0)'
    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
    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
    productCustomerType:
      title: Product Customer Type (v1.0.0)
      description: |+
        Indicates the type of customer that uses this banking product: personal (retail) or business (commercial).

        <strong><code>productCustomerType</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>personal</code></strong></td><td>Personal: <p>Retail banking products for personal customers</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>business</code></strong></td><td>Business: <p>Commercial banking products for business customers</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>both</code></strong></td><td>Personal and Business: <p>Banking products for personal or business customers</p>
        </td>
            </tr>
        </table>

      type: string
      enum:
        - personal
        - business
        - both
      x-apiture-enum: productCustomerType
      x-resolved-from: ../../products/openapi.yaml#/components/schemas/productCustomerType
      x-apiture-version: 1.0.0
    yearsAtAddress:
      title: Years at Address (v1.0.0)
      description: Categories for how long the person has been at their present home address.
      type: string
      enum:
        - unknown
        - oneOrFewer
        - two
        - three
        - fourOrMore
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/yearsAtAddress
      x-apiture-version: 1.0.0
    customerPhoneNumbers:
      title: Customer Phone Numbers (v1.0.0)
      description: A customer's phone numbers.
      type: object
      required:
        - primary
      properties:
        primary:
          description: The primary phone number of the customer.
          $ref: '#/components/schemas/simplePhoneNumber'
        secondary:
          description: The secondary phone number of the customer. This object is omitted if there is not a secondary phone number.
          $ref: '#/components/schemas/simplePhoneNumber'
        mobile:
          description: The mobile phone number of the customer. This object is omitted if there is not a mobile phone number.
          $ref: '#/components/schemas/simplePhoneNumber'
        alternate:
          description: The alternate phone number of the customer. This object is omitted if there is not an alternate phone number.
          $ref: '#/components/schemas/simplePhoneNumber'
        fax:
          description: The fax number of the customer. This object is omitted if there is not a fax phone number.
          $ref: '#/components/schemas/simplePhoneNumber'
      example:
        primary: '+19105550155'
        mobile: '+19105550150'
      x-resolved-from: ../../customers/openapi.yaml#/components/schemas/customerPhoneNumbers
      x-apiture-version: 1.0.0
    applicantResidencyStatus:
      title: Applicant US Residency Status (v1.0.0)
      description: Describes the type of US residency status if the applicant is not a US citizen.
      type: string
      enum:
        - unknown
        - resident
        - nonresident
        - residentAlien
        - nonresidentAlien
        - other
        - notApplicable
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicantResidencyStatus
      x-apiture-version: 1.0.0
    governmentIssuedIdFields:
      title: Government Issued ID Fields (v1.0.0)
      description: A fragment schema with fields for a government-issued ID.
      type: object
      x-apiture-fragment: true
      properties:
        type:
          title: Identification Type
          description: Indicates what type of state, government, or other authority issued identification used for a person's identification. This is a programmatic identifier, such as `driversLicense`, `stateId`, `passport` or `militaryId`, not a label.
          type: string
          format: text
          maxLength: 32
          example: driversLicense
        number:
          description: The ID number on the government- or authority- issued identification, such as a driver's license, military ID, or state-issued ID card. The value is masked in responses unless the caller requests unmasked personally identifiable information (PII).
          type: string
          format: text
          maxLength: 50
          example: A123-456-789-123
        issuingAuthority:
          description: The code/abbreviation of the government authority which issued the identification number, such as `"NC"` for  a driver's license issued in North Carolina. For national issuers (such as `passport`), this should be the [ISO-3611 alpha-2](https://www.iso.org/glossary-for-iso-3166.html) value for the country.
          type: string
          format: text
          maxLength: 6
          example: MN
        issuedOn:
          description: The date the government or authority issued the identification number.
          $ref: '#/components/schemas/date'
        expiresOn:
          description: The date the government- or authority- issued identification number expires. Normally, the user must submit a non-expired ID number.
          $ref: '#/components/schemas/date'
      example:
        type: driversLicense
        number: '01234567'
        issuingAuthority: NC
        issuedOn: '2020-07-10'
        expiresOn: '2026-07-10'
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/governmentIssuedIdFields
      x-apiture-version: 1.0.0
    date:
      title: Date (v1.0.0)
      description: A date formatted in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) `date` UTC format.
      type: string
      minLength: 10
      maxLength: 10
      format: date
      example: '2021-10-30'
      x-apiture-since: 0.5.0
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/date
      x-apiture-version: 1.0.0
    applicantEmploymentStatus:
      x-apiture-version: 1.1.0
      title: Applicant Employment Status (v1.1.0)
      description: The applicant's employment status.
      type: string
      enum:
        - unknown
        - fullTime
        - partTime
        - paidLeave
        - selfEmployed
        - retired
        - unemployed
        - other
        - notApplicable
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicantEmploymentStatus
    occupationType:
      title: Occupation Type (v1.0.0)
      description: |+
        The type of occupation an applicant or customer holds

        <strong><code>occupationType</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>unknown</code></strong></td><td>Unknown: <p>Occupation is unknown</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>architectureAndEngineering</code></strong></td><td>Architecture and Engineering</td>
            </tr>
        <tr>
            <td><strong><code>artsDesignEntertainmentSportsAndMedia</code></strong></td><td>Arts, Design, Entertainment, Sports and Media</td>
            </tr>
        <tr>
            <td><strong><code>buildingAndGroundsCleaningAndMaintenance</code></strong></td><td>Building and Grounds Cleaning and Maintenance</td>
            </tr>
        <tr>
            <td><strong><code>businessAndFinancialOperations</code></strong></td><td>Business and Financial Operations</td>
            </tr>
        <tr>
            <td><strong><code>communityAndSocialService</code></strong></td><td>Community and Social Service</td>
            </tr>
        <tr>
            <td><strong><code>computerAndMathematical</code></strong></td><td>Computer and Mathematical</td>
            </tr>
        <tr>
            <td><strong><code>constructionAndExtraction</code></strong></td><td>Construction and Extraction</td>
            </tr>
        <tr>
            <td><strong><code>educationTrainingAndLibrary</code></strong></td><td>Education, Training and Library</td>
            </tr>
        <tr>
            <td><strong><code>farmingFishingAndForestry</code></strong></td><td>Farming, Fishing and Forestry</td>
            </tr>
        <tr>
            <td><strong><code>foodPreparationAndServingRelated</code></strong></td><td>Food Preparation and Serving Related</td>
            </tr>
        <tr>
            <td><strong><code>healthcarePractitionersAndTechnical</code></strong></td><td>Healthcare Practitioners and Technical</td>
            </tr>
        <tr>
            <td><strong><code>healthcareSupport</code></strong></td><td>Healthcare Support</td>
            </tr>
        <tr>
            <td><strong><code>installationMaintenanceAndRepair</code></strong></td><td>Installation, Maintenance and Repair</td>
            </tr>
        <tr>
            <td><strong><code>legal</code></strong></td><td>Legal: <p>Judiciary, Law and Order</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>lifePhysicalAndSciences</code></strong></td><td>Life, Physical and Sciences</td>
            </tr>
        <tr>
            <td><strong><code>management</code></strong></td><td>Management</td>
            </tr>
        <tr>
            <td><strong><code>militarySpecific</code></strong></td><td>Military Specific</td>
            </tr>
        <tr>
            <td><strong><code>officeAndAdministrativeSupport</code></strong></td><td>Office and Administrative Support</td>
            </tr>
        <tr>
            <td><strong><code>personalCareAndService</code></strong></td><td>Personal Care and Service</td>
            </tr>
        <tr>
            <td><strong><code>production</code></strong></td><td>Production</td>
            </tr>
        <tr>
            <td><strong><code>protectiveServices</code></strong></td><td>Protective Services</td>
            </tr>
        <tr>
            <td><strong><code>salesAndRelated</code></strong></td><td>Sales and Related</td>
            </tr>
        <tr>
            <td><strong><code>transportationAndMaterialMoving</code></strong></td><td>Transportation and Material Moving</td>
            </tr>
        <tr>
            <td><strong><code>other</code></strong></td><td>Other</td>
            </tr>
        <tr>
            <td><strong><code>notApplicable</code></strong></td><td>Not applicable</td>
            </tr>
        </table>

      x-apiture-enum: occupationType
      type: string
      enum:
        - unknown
        - architectureAndEngineering
        - artsDesignEntertainmentSportsAndMedia
        - buildingAndGroundsCleaningAndMaintenance
        - businessAndFinancialOperations
        - communityAndSocialService
        - computerAndMathematical
        - constructionAndExtraction
        - educationTrainingAndLibrary
        - farmingFishingAndForestry
        - foodPreparationAndServingRelated
        - healthcarePractitionersAndTechnical
        - healthcareSupport
        - installationMaintenanceAndRepair
        - legal
        - lifePhysicalAndSciences
        - management
        - militarySpecific
        - officeAndAdministrativeSupport
        - personalCareAndService
        - production
        - protectiveServices
        - salesAndRelated
        - transportationAndMaterialMoving
        - other
        - notApplicable
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/occupationType
      x-apiture-version: 1.0.0
    simplePhoneNumber:
      x-apiture-version: 1.1.0
      title: Simple Phone Number (v1.1.0)
      description: The phone number as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is `+1`. Phone numbers are returned in responses in [E.164](https://en.wikipedia.org/wiki/E.164) format with a leading `+`, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See [Phone Number Representations](https://developer.apiture.com/docs/concepts/phone-numbers/) for more information. If the number is masked to hide Personally Identifiable Information, all but the last four digits are replaced with one or more `*`, such as `*1234`.
      type: string
      example: '+19105550155'
      minLength: 5
      maxLength: 20
      format: phone-number
      x-apiture-since: 0.5.0
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/simplePhoneNumber
    applicantIdentityVerificationType:
      title: Applicant Identity Verification Type (v1.0.0)
      description: |+
        Describes how the identity verification was performed.

        <strong><code>applicantIdentityVerificationType</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>fraudRiskReport</code></strong></td><td>Fraud Risk Report: <p>Verification performed by generating a fraud risk report based on the identity&#39;s personal information.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>quiz</code></strong></td><td>Quiz: <p>Verification performed by executing a quiz based on personal knowledge the individual should know.</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>adminApproval</code></strong></td><td>Admin Approval: <p>Verification performed by an administrator explicitly approving the identity, for example after manually inspecting identity verification documents from the applicant.</p>
        </td>
            </tr>
        </table>

      type: string
      enum:
        - fraudRiskReport
        - quiz
        - adminApproval
      x-apiture-enum: applicantIdentityVerificationType
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicantIdentityVerificationType
      x-apiture-version: 1.0.0
    applicationDocumentFields:
      x-apiture-version: 1.1.1
      title: Application Document Fields (v1.1.1)
      description: Fields used to compose application document schemas.
      x-apiture-fragment: true
      type: object
      properties:
        type:
          description: The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents (such as a `governmentId` etc.).
          type: string
          format: text
          maxLength: 32
          example: governmentId
        contentType:
          description: The [media type](https://tools.ietf.org/html/rfc6838) for this file. For text documents, the content type should include the text encoding; if omitted, the encoding type is assumed to be utf-8.
          $ref: '#/components/schemas/contentType'
          example: application/pdf
        documentTarget:
          description: The target of the relevant banking product, either `business` or `personal`.
          $ref: '#/components/schemas/applicationCustomerType'
        category:
          $ref: '#/components/schemas/documentCategory'
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/applicationDocumentFields
    organizationContactCard:
      title: Customer Application Organization Contact Card (v1.0.0)
      description: An organization's contact information.
      type: object
      required:
        - addresses
        - emailAddress
        - phoneNumbers
      properties:
        addresses:
          description: The organization's postal addresses.
          $ref: '#/components/schemas/organizationAddresses'
        emailAddress:
          description: The email address of the organization's primary contact.
          $ref: '#/components/schemas/customerEmailAddress'
        phoneNumbers:
          description: The organization's phone numbers.
          $ref: '#/components/schemas/organizationPhoneNumbers'
        home_url:
          description: The organization's home page.
          type: string
          format: uri
          maxLength: 2048
      example:
        addresses:
          primary:
            address1: 1805 Tiburon Dr.
            locality: Wilmington
            regionCode: NC
            countryCode: US
            postalCode: '28412'
          mailing:
            address1: P.O. Box 1805
            locality: Wilmington
            regionCode: NC
            countryCode: US
            postalCode: '28412'
        emailAddress: Max.Peck@example.com
        phoneNumbers:
          primary: '+19105550155'
          primaryPhoneNumberExtension: '347'
        home_url: http://max-peck-mobile-service.example.com
      x-resolved-from: ../../organizations/openapi.yaml#/components/schemas/organizationContactCard
      x-apiture-version: 1.0.0
    lowerCamelCaseIdentifier40:
      title: Lower Camel Case Identifier (v1.0.0)
      description: A Lower Camel Case Identifier string, up to 40 characters long.
      type: string
      minLength: 2
      maxLength: 40
      pattern: ^[a-z][a-zA-Z0-9]{1,39}$
      examples:
        - accountId
        - transactionId400
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/lowerCamelCaseIdentifier40
      x-apiture-version: 1.0.0
    lowerCamelCaseIdentifier64:
      title: Lower Camel Case Identifier (v1.0.0)
      description: A Lower Camel Case Identifier string, up to 64 characters long.
      type: string
      minLength: 2
      maxLength: 64
      pattern: ^[a-z][a-zA-Z0-9]{1,63}$
      examples:
        - accountId
        - transactionId400
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/lowerCamelCaseIdentifier64
      x-apiture-version: 1.0.0
    organizationIntermediaryService:
      title: Intermediary Service (v1.0.0)
      description: Intermediary/non-bank financial institution services.
      type: string
      enum:
        - unknown
        - accounting
        - fundsManagement
        - insurance
        - investment
        - legal
        - medical
        - notary
        - realEstate
        - taxPreparation
        - trustManagement
        - gambling
        - securities
        - loanFinance
        - pawnBrokerage
        - travelAgency
        - vehicleSales
        - foreignCurrency
        - preciousMetals
        - other
        - notApplicable
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/organizationIntermediaryService
      x-apiture-version: 1.0.0
    beneficialOwnerGovernmentIssuedId:
      title: Beneficial Owner Government-Issued Identification (v1.0.0)
      description: Describes a secondary form of government-issued identification for a beneficial owner.
      type: object
      allOf:
        - $ref: '#/components/schemas/governmentIssuedIdFields'
      required:
        - type
        - number
      example:
        type: driversLicense
        number: '01234567'
        issuingAuthority: NC
        issuedOn: '2020-07-10'
        expiresOn: '2026-07-10'
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/beneficialOwnerGovernmentIssuedId
      x-apiture-version: 1.0.0
    monetaryValue:
      x-apiture-version: 1.1.1
      title: Monetary Value (v1.1.1)
      description: The monetary value, supporting only positive amounts. The numeric value is  represented as a string so that it can be exact with no loss of precision.
      example: '3456.78'
      format: decimal
      type: string
      pattern: ^(0|[1-9][0-9]*)\.[0-9][0-9]$
      maxLength: 16
      x-apiture-since: 0.4.0
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/monetaryValue
    currencyCode:
      description: A [ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217) This is always upper case ASCII. Crypto currencies with codes longer that 3 characters are not supported.
      type: string
      format: text
      pattern: ^[A-Z]{3}$
      minLength: 3
      maxLength: 3
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/currencyCode
      x-apiture-version: 1.0.0
      title: ' (v1.0.0)'
    fullAddressFields:
      x-apiture-version: 1.2.1
      title: Full Address Fields (v1.2.1)
      description: A postal address that can hold a US address or an international (non-US) postal addresses.
      type: object
      x-apiture-fragment: true
      allOf:
        - $ref: '#/components/schemas/addressFields'
        - type: object
          properties:
            regionName:
              type: string
              minLength: 2
              maxLength: 20
              format: text
              description: The state, district, or outlying area of the postal address. This is required if `countryCode` is not `US`. `regionCode` and `regionName` are mutually exclusive.
              examples:
                - Alessandria
                - Rio de Janeiro
                - British Columbia
            regionCode:
              type: string
              maxLength: 2
              minLength: 2
              pattern: ^[A-Za-z]{2}$
              description: The state, district, or outlying area of the postal address. This is required if `countryCode` is `US`. `regionCode` and `regionName` are mutually exclusive.
              examples:
                - NC
                - IL
                - VI
            postalCode:
              $ref: '#/components/schemas/postalCode'
      examples:
        - address1: 1805 Tiburon Dr.
          address2: Building 14, Suite 1500
          locality: Wilmington
          regionCode: NC
          countryCode: US
          postalCode: '28403'
        - address1: 999 Canada Place
          locality: Vancouver
          regionName: British Columbia
          countryCode: CA
          postalCode: V6C 3T4
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/fullAddressFields
    adminUserState:
      title: Admin User State (v1.0.0)
      description: |+
        The current state of the admin user.

        <strong><code>adminUserState</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>active</code></strong></td><td>Active: <p>The admin user is active</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>locked</code></strong></td><td>Locked: <p>The admin user&#39;s account is locked</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>removed</code></strong></td><td>Removed: <p>The admin user has been been removed from the system</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: adminUserState
      enum:
        - active
        - locked
        - removed
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/adminUserState
      x-apiture-version: 1.0.0
    adminNoteAttachmentFields:
      title: Admin Note Attachment Fields (v1.0.0)
      description: Common fields of the admin note attachment resource used to build other model schemas.
      x-apiture-fragment: true
      type: object
      properties:
        name:
          description: The name of this attachment.
          type: string
          format: text
          maxLength: 128
        contentType:
          description: The content type (media type) of the attachment. Media types with `*` wildcards are not allowed.
          type: string
          pattern: ^[-a-z0-9]{4,48}\/[-+a-z0-9.]{3,142}$
          minLength: 8
          maxLength: 191
          example: image/png
          allOf:
            - $ref: '#/components/schemas/adminNoteContentType'
        url:
          description: The URL of the attachment. This URL should be directly viewable by admin users without requiring an additional `Authorization` or other request headers.
          type: string
          format: uri
          maxLength: 2048
      x-resolved-from: ../../adminNotes/openapi.yaml#/components/schemas/adminNoteAttachmentFields
      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
    contentType:
      x-apiture-version: 1.0.1
      title: Content Type (v1.0.1)
      description: The [media type](https://tools.ietf.org/html/rfc6838) of a file.
      type: string
      minLength: 8
      maxLength: 191
      pattern: ^[-a-z0-9]{4,48}\/[-+a-z0-9.]{3,142}$
      example: application/pdf
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/contentType
    documentCategory:
      title: Document Category (v1.0.0)
      description: |+
        Document categories for documents requested or uploaded as part of an account application.

        <strong><code>documentCategory</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>articlesOfOrganization</code></strong></td><td>Articles Of Organization: <p>Articles Of Organization</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>assumedNameCertificate</code></strong></td><td>Assumed Name Certificate: <p>Assumed Name Certificate if the business is &quot;Doing Business As&quot; in a name other than your own</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>businessLicense</code></strong></td><td>Business License: <p>Issued business document that grants permission to operate within a particular jurisdiction</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>certificateOfGoodStanding</code></strong></td><td>Certificate of Good Standing: <p>Certificate of Good Standing authorizing your ability to do business for the issuing state</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>certificateOfPartnership</code></strong></td><td>Certificate of Partnership: <p>Certificate of Partnership, Partnership Agreement, or Affidavit of Partnership</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>certificationOfBeneficialOwnership</code></strong></td><td>Certification of Beneficial Ownership: <p>Completed and Signed Beneficial Ownership Certification Form</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>driversLicense</code></strong></td><td>Drivers License: <p>Drivers License</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>employerIdNumberConfirmationLetter</code></strong></td><td>Employer ID Number Confirmation Letter: <p>Copy of EIN certification letter from the IRS, TT&amp;L Payment, Tax return or other evidence of the EIN, unless you operate with your SSN</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>operatingAgreement</code></strong></td><td>Operating Agreement: <p>Operating Agreement or Affidavit of LLC</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>passport</code></strong></td><td>Passport: <p>Passport</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>socialSecurityCard</code></strong></td><td>Social Security Card: <p>Social Security Card</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>stateIdentification</code></strong></td><td>State Identification: <p>State Identification</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>taxForm</code></strong></td><td>Tax Form: <p>Tax Form</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>utilityBill</code></strong></td><td>Utility Bill: <p>Utility Bill</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>websiteEvidence</code></strong></td><td>Website Evidence: <p>Evidence from respective State website that the company is Active</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>other</code></strong></td><td>Other: <p>Other document</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: documentCategory
      enum:
        - articlesOfOrganization
        - assumedNameCertificate
        - businessLicense
        - certificateOfGoodStanding
        - certificateOfPartnership
        - certificationOfBeneficialOwnership
        - driversLicense
        - employerIdNumberConfirmationLetter
        - operatingAgreement
        - passport
        - socialSecurityCard
        - stateIdentification
        - taxForm
        - utilityBill
        - websiteEvidence
        - other
      example: driversLicense
      x-resolved-from: ../../applications/openapi.yaml#/components/schemas/documentCategory
      x-apiture-version: 1.0.0
    organizationAddresses:
      title: Organization Addresses (v1.0.0)
      description: An applicant's postal addresses.
      type: object
      properties:
        primary:
          description: The organization's primary address. For individuals, this is their home address. For businesses, this is the company's business address.
          $ref: '#/components/schemas/address'
        mailing:
          description: The organization's mailing address. If present, financial institution sends statements and other documents to this address instead of the `primary` address.
          $ref: '#/components/schemas/address'
        previous:
          description: The organization's previous address.
          $ref: '#/components/schemas/address'
      example:
        primary:
          address1: 1805 Tiburon Dr.
          locality: Wilmington
          regionCode: NC
          countryCode: US
          postalCode: '28412'
        mailing:
          address1: P.O. Box 1805
          locality: Wilmington
          regionCode: NC
          countryCode: US
          postalCode: '28412'
      x-resolved-from: ../../organizations/openapi.yaml#/components/schemas/organizationAddresses
      x-apiture-version: 1.0.0
    organizationPhoneNumbers:
      title: Organization Phone Numbers (v1.0.0)
      description: The organizations's phone numbers.
      allOf:
        - $ref: '#/components/schemas/customerPhoneNumbers'
        - type: object
          properties:
            primaryPhoneNumberExtension:
              description: The phone number extension of the primary phone number.
              type: string
              pattern: ^[0-9]{1,8}$
              minLength: 1
              maxLength: 8
      x-resolved-from: ../../organizations/openapi.yaml#/components/schemas/organizationPhoneNumbers
      x-apiture-version: 1.0.0
    addressFields:
      x-apiture-version: 1.4.0
      title: Address Fields (v1.4.0)
      description: Properties of a simple address, used to compose other addresses.
      x-apiture-fragment: true
      properties:
        address1:
          type: string
          description: The first line of the postal address. In the US, this typically includes the building number and street name.
          example: 1805 Tiburon Dr.
          maxLength: 35
          format: text
        address2:
          type: string
          description: The second line of the street address. This should only be used if it has a value. Typical values include building numbers, suite numbers, and other identifying information beyond the first line of the postal address.
          example: Building 14, Suite 1500
          maxLength: 35
          format: text
        locality:
          type: string
          description: The city/town/municipality of the address.
          examples:
            - Wilmington
            - Atlanta
          maxLength: 30
          format: text
        countryCode:
          $ref: '#/components/schemas/countryCode'
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/addressFields
    postalCode:
      title: Postal code (v1.0.0)
      description: The postal code, which varies in format by country. For postal codes in the US, this should be a five digit US ZIP code or ten character ZIP+4.
      type: string
      minLength: 2
      maxLength: 20
      pattern: '[0-9A-Za-z][- 0-9A-Za-z]{0,18}[0-9A-Za-z]'
      examples:
        - '20521'
        - 20521-1380
        - V6C 3T4
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/postalCode
      x-apiture-version: 1.0.0
    adminNoteContentType:
      title: Admin Note Content Type (v1.0.0)
      description: The list of allowed content types for admin notes.
      type: string
      enum:
        - text/plain
        - image/bmp
        - image/gif
        - image/png
        - image/jpeg
        - image/tiff
        - application/msword
        - application/pdf
        - application/vnd.openxmlformats-officedocument.wordprocessingml.document
      x-resolved-from: ../../adminNotes/openapi.yaml#/components/schemas/adminNoteContentType
      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
    countryCode:
      title: Country Code (v1.0.0)
      description: The [ISO-3611 alpha-2](https://www.iso.org/glossary-for-iso-3166.html) value for a country.
      type: string
      minLength: 2
      maxLength: 2
      pattern: ^[A-Za-z]{2}$
      examples:
        - US
        - CA
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/countryCode
      x-apiture-version: 1.0.0
    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:
    clientCredentials:
      type: oauth2
      description: Client Credentials OAuth2 flow that allows a secure service application to access resources. (This access is not used with insecure clients such as web or mobile applications.) See details at [Secure Access](https://dx.apiture.com/docs/api/guides/secure-access/).
      flows:
        clientCredentials:
          tokenUrl: https://dev-oidc.apiture-comm-nonprod.com/oidc/token
          scopes:
            bankingAdmin/read: Read a wide variety of banking and other financial institution and customer data.
    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:
    accountApplicationCannotBeResumed:
      description: The account application cannot be resumed. For example, resuming is not allowed if the applicant has canceled their application.
      remediation: If possible, alter or repair the application. Remediation is not always possible.
    invalidStateForResume:
      description: The account application cannot be resumed due to other application data that requires repair.
      remediation: Perform additional application repair.
    creationDateTimeFilterConflict:
      description: The `creationPeriod` and `createdAt` query parameters are mutually exclusive.
      remediation: Pass only one of `creationPeriod` and `createdAt`.
    unmaskingParametersAreMutuallyExclusive:
      description: The `unmasked` and `unmaskedFields` query parameters are mutually exclusive.
      remediation: Pass only one of `unmasked` and `unmaskedFields`.
    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
    tooManyRequests:
      description: The client has sent too many requests in a given amount of time, exceeding rate limiting.
      remediation: Slow down the rate of API calls.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/tooManyRequests
  responses:
    '400':
      description: |
        Bad Request. The request body, request headers, and/or query parameters are not well-formed.

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

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

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

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

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

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

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

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

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

        This problem response may have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/tooManyRequests/v1.0.0`](https://static.api.apiture.com/errors/tooManyRequests/v1.0.0)<br>
          The client has sent too many requests in a given amount of time, exceeding rate limiting.
          Remediation: Slow down the rate of API calls.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/tooManyRequests'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/tooManyRequests/v1.0.0
              title: Too Many Requests
              status: 429
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The user has sent too many requests in a given amount of time.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/tooManyRequests/v1.0.0
              title: Too Many Requests
              status: 429
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The user has sent too many requests in a given amount of time.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/429
    clientCredentials403:
      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.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/forbidden'
      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/clientCredentials403
    4XX:
      description: Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/methodNotAllowed/v1.0.0
              title: Method Not Allowed
              status: 405
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: This HTTP method is not allowed for the given resource URL.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/methodNotAllowed/v1.0.0
              title: Method Not Allowed
              status: 405
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: This HTTP method is not allowed for the given resource URL.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/4XX
    5XX:
      description: Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/gatewayTimeout/v1.0.0
              title: Insufficient Storage
              status: 507
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The server is unable to store the representation needed to successfully complete the request.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/gatewayTimeout/v1.0.0
              title: Insufficient Storage
              status: 507
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The server is unable to store the representation needed to successfully complete the request.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/5XX
x-apiture-traits:
  - resource:
      name: customer account application
      excludeMethods:
        - post
        - put
        - patch
        - delete
  - security:
      baseScope: bankingAdmin
x-resolved-from: ../../adminApplications/status-codes-openapi.yaml
x-resolved-at: '2024-12-09T21:59:56.721Z'
x-apiture-annotated-at: '2024-12-09T21:59:57.022Z'
