> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tesouro.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get bank requirements

> Returns everything the bank asks of a bank account application in the version of its requirements
in effect today: the sections to ask in, and every question with its type, checks and wording. A
BANK or PLATFORM caller can ask on behalf of an organization beneath it with the X-Organization-ID
header.

**Token types:** APP, USER | **Required scopes:** `bank_account_application:read:org`

> [!NOTE]
>
> This feature is in Beta and not ready for production integration.


## OpenAPI

````yaml /.tooling/schemas/rest/tags/product-embedded-banking.json get /bank-account-applications/requirements
openapi: 3.1.0
info:
  title: Tesouro Partner API
  version: '2025-06-23'
  description: The Tesouro REST API, for Tesouro partners to integrate with our solution.
  termsOfService: https://tesouro.com/terms
  contact:
    name: Tesouro team
    url: https://tesouro.com/about/
    email: developers@tesouro.com
servers:
  - url: https://api.sandbox.tesouro.com
    description: Sandbox
security: []
tags:
  - name: Applications
  - name: Authorization Controls
  - name: Bank Accounts
  - name: Beneficial Owners
  - name: Checks
  - name: Debit Cards
  - name: Departments
  - name: Disclosures
  - name: Embedded Banking
  - name: External Bank Accounts
  - name: Instant Payment Eligibility
  - name: Instant Payment Limits
  - name: Locations
  - name: Money Movement
  - name: OIDC applications
  - name: Organization Summary
  - name: Organizations
  - name: Roles
  - name: Users
paths:
  /bank-account-applications/requirements:
    servers:
      - url: https://api.sandbox.tesouro.com/embedded-banking/v1
        description: Sandbox
    get:
      tags:
        - Applications
        - Embedded Banking
      summary: Get bank requirements
      description: >-
        Returns everything the bank asks of a bank account application in the
        version of its requirements

        in effect today: the sections to ask in, and every question with its
        type, checks and wording. A

        BANK or PLATFORM caller can ask on behalf of an organization beneath it
        with the X-Organization-ID

        header.


        **Token types:** APP, USER | **Required scopes:**
        `bank_account_application:read:org`
      operationId: GetBankAccountApplicationRequirements
      parameters:
        - name: X-Organization-ID
          in: header
          description: >-
            ID of the organization to perform this operation on behalf of.
            Required for BANK and PLATFORM app token callers targeting a
            specific organization. If omitted, the request uses the
            authenticated caller's own organization. Must be a valid non-empty
            UUID. Present but malformed values return 400.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Requirements retrieved successfully.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BankAccountApplicationRequirementsResponse
        '400':
          description: >-
            The X-Organization-ID header is malformed, or the request could not
            be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbedValidationProblemDetails'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: The token lacks the scope to read bank account applications.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: The organization in X-Organization-ID was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbedProblemDetails'
      security:
        - APPToken:
            - bank_account_application:read:org
        - USERToken:
            - bank_account_application:read:org
components:
  schemas:
    BankAccountApplicationRequirementsResponse:
      required:
        - bank
        - version
        - supersedes
        - supersededBy
        - sections
        - questions
      type: object
      properties:
        bank:
          $ref: '#/components/schemas/ApplicationRequirementsBank'
          description: The bank whose requirements these are.
        questions:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationQuestion'
          description: >-
            Every question the bank asks, in the order to ask them within each
            section.
        sections:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationRequirementsSection'
          description: >-
            The sections the questions are grouped into, in the order to ask
            them.
        supersededBy:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/ApplicationRequirementsVersion'
              description: >-
                The version that replaces this one, once it is published. Null
                until then.
        supersedes:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/ApplicationRequirementsVersion'
              description: >-
                The version this one replaced. Null for the bank's first
                version.
        version:
          $ref: '#/components/schemas/ApplicationRequirementsVersion'
          description: The version of the bank's requirements described here.
      description: >-
        Everything a bank asks of a bank account application in one version of
        its requirements: the

        sections to ask in, and every question with its type, checks and
        wording.
    EmbedValidationProblemDetails:
      required:
        - errorCode
      type: object
      properties:
        detail:
          type:
            - 'null'
            - string
        errorCode:
          type: string
          description: Embed-specific error code for client error handling.
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        instance:
          type:
            - 'null'
            - string
        questionErrors:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/QuestionError'
          description: >-
            The application questions that failed. Null when the endpoint
            validates no application questions.
        requirementsVersion:
          type:
            - 'null'
            - string
          description: >-
            The application requirements version the request was validated
            against. Null when none applies.
        status:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - 'null'
            - integer
            - string
          format: int32
        title:
          type:
            - 'null'
            - string
        type:
          type:
            - 'null'
            - string
      description: >-
        Problem details for a request the service rejected as invalid.

        Follows RFC 7807, with the Embed error code and the fields and questions
        that failed.
    ProblemDetails:
      type: object
      properties:
        detail:
          type:
            - 'null'
            - string
        instance:
          type:
            - 'null'
            - string
        status:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - 'null'
            - integer
            - string
          format: int32
        title:
          type:
            - 'null'
            - string
        type:
          type:
            - 'null'
            - string
    EmbedProblemDetails:
      type: object
      properties:
        detail:
          type:
            - 'null'
            - string
        errorCode:
          type:
            - 'null'
            - string
          description: >-
            Embed-specific error code for client error handling.

            Stored in the Extensions dictionary to ensure proper JSON
            serialization.
        instance:
          type:
            - 'null'
            - string
        status:
          pattern: ^-?(?:0|[1-9]\d*)$
          type:
            - 'null'
            - integer
            - string
          format: int32
        title:
          type:
            - 'null'
            - string
        type:
          type:
            - 'null'
            - string
      description: |-
        Extended ProblemDetails with Embed-specific error code.
        Follows RFC 7807 with additional error code field.
    ApplicationRequirementsBank:
      required:
        - slug
        - name
      type: object
      properties:
        name:
          type: string
          description: The bank's name, suitable for showing to the applicant.
        slug:
          type: string
          description: >-
            The bank's identifier within a requirements version id, e.g.
            example-bank.
      description: The bank an application is made to.
    ApplicationQuestion:
      required:
        - key
        - section
        - surface
        - path
        - type
        - required
        - sensitive
        - ui
      type: object
      properties:
        appliesTo:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/ApplicationQuestionAppliesTo'
              description: >-
                Who the question is asked of, when it is not asked once per
                application.
        items:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/ApplicationQuestionItem'
              description: For an array, what each of its items is.
        key:
          type: string
          description: The question's identifier, e.g. business.legalName.
        path:
          type: string
          description: >-
            Where the answer goes in a create or update request body, as a
            dotted path in which [] stands for

            each item of a list, e.g. businessOwners[].firstName.
        properties:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/ApplicationQuestionProperty'
          description: For a composite, its parts.
        required:
          $ref: '#/components/schemas/ApplicationQuestionRequired'
          description: When an answer must be given.
        rules:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/ApplicationQuestionRule'
          description: The checks a given answer must pass. Absent when there are none.
        section:
          type: string
          description: The key of the section the question is asked in.
        sensitive:
          type: boolean
          description: >-
            Whether the answer is personal or confidential information, to be
            handled and displayed with care.
        surface:
          $ref: '#/components/schemas/ApplicationQuestionSurface'
          description: The part of the application the answer belongs to.
        type:
          type: string
          description: >-
            The answer's type: string, identifier (a number that identifies a
            person or business to an

            authority, such as a passport number), boolean, integer, decimal,
            date (YYYY-MM-DD), enum (one of

            values, or of the values of the schema named by valuesFrom), array
            (a list, whose items are

            described by items), or one of the composites address,
            taxIdentificationNumber and

            personalIdentificationNumber, whose parts are listed in properties.
        ui:
          $ref: '#/components/schemas/ApplicationQuestionUi'
          description: The wording to show the applicant.
        values:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/ApplicationQuestionValue'
          description: For an enum that lists its own values, each value it may take.
        valuesFrom:
          type:
            - 'null'
            - string
          description: >-
            For an enum, the name of the schema in this API that lists its
            values, e.g. CountryCode.
      description: >-
        A question the bank asks, with what is needed to ask it and to check the
        answer before submitting.
    ApplicationRequirementsSection:
      required:
        - key
        - label
      type: object
      properties:
        key:
          type: string
          description: >-
            The section's identifier, which each of its questions names in
            section.
        label:
          type: string
          description: The section's title, suitable for showing to the applicant.
      description: A group of questions asked together.
    ApplicationRequirementsVersion:
      required:
        - id
        - publishedAt
        - effectiveFrom
        - retiredAt
        - status
      type: object
      properties:
        id:
          type: string
          description: >-
            The version's identifier: the bank's slug and the date the version
            takes effect, e.g. example-bank@2026-01-01.
        effectiveFrom:
          type: string
          description: >-
            The date from which the version is the minimum the bank accepts,
            YYYY-MM-DD.
          format: date
        publishedAt:
          type: string
          description: The date the version was published, YYYY-MM-DD.
          format: date
        retiredAt:
          type:
            - 'null'
            - string
          description: >-
            The date the version is withdrawn, YYYY-MM-DD. Null while no
            withdrawal is scheduled.
          format: date
        status:
          $ref: '#/components/schemas/ApplicationRequirementsVersionStatus'
          description: Where the version stands today.
      description: One version of a bank's requirements and where it stands today.
    QuestionError:
      required:
        - code
        - message
      type: object
      properties:
        code:
          $ref: '#/components/schemas/QuestionErrorCode'
          description: Why the question failed.
        itemPath:
          type:
            - 'null'
            - string
          description: >-
            Where inside an array-valued answer the failure is, relative to the
            question, such as

            `[0].name`.
        key:
          type:
            - 'null'
            - string
          description: >-
            The question's stable key. Null when no single question owns the
            failure.
        message:
          type: string
          description: >-
            A readable description of the failure, for display. Its wording is
            not part of the contract.
        ownerId:
          type:
            - 'null'
            - string
          description: The owner whose answer failed. Present for per-owner questions only.
          format: uuid
      description: One application question that failed validation.
    ApplicationQuestionAppliesTo:
      enum:
        - EACH_OWNER
      type: string
    ApplicationQuestionItem:
      required:
        - type
      type: object
      properties:
        properties:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/ApplicationQuestionProperty'
          description: For an object, its parts.
        rules:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/ApplicationQuestionRule'
          description: The checks each item must pass. Absent when there are none.
        type:
          type: string
          description: >-
            The item's type: any of a question's types except array and the
            composites, or object, whose parts

            are listed in properties.
        values:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/ApplicationQuestionValue'
          description: For an enum that lists its own values, each value it may take.
        valuesFrom:
          type:
            - 'null'
            - string
          description: >-
            For an enum, the name of the schema in this API that lists its
            values, e.g. CountryCode.
      description: What each item of a list answer is.
    ApplicationQuestionProperty:
      required:
        - key
        - type
        - required
        - ui
      type: object
      properties:
        key:
          type: string
          description: >-
            The part's name within the composite or item, as it appears in the
            request body.
        required:
          $ref: '#/components/schemas/ApplicationQuestionRequired'
          description: When the part must be given, once the question is answered.
        rules:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/ApplicationQuestionRule'
          description: The checks a given value must pass. Absent when there are none.
        type:
          type: string
          description: >-
            The part's type: any of a question's types except array and the
            composites.
        ui:
          $ref: '#/components/schemas/ApplicationQuestionUi'
          description: The wording to show the applicant.
        values:
          type:
            - 'null'
            - array
          items:
            $ref: '#/components/schemas/ApplicationQuestionValue'
          description: For an enum that lists its own values, each value it may take.
        valuesFrom:
          type:
            - 'null'
            - string
          description: >-
            For an enum, the name of the schema in this API that lists its
            values, e.g. CountryCode.
      description: >-
        One part of a composite answer, such as an address's city, or of each
        item of a list answer.
    ApplicationQuestionRequired:
      enum:
        - SUBMIT
        - NEVER
      type: string
      description: When an answer must be given.
    ApplicationQuestionRule:
      required:
        - rule
      type: object
      properties:
        rule:
          type: string
          description: >-
            The check: notEmpty, length (exactly value characters), maxLength
            (at most value characters), min or

            max (an inclusive bound of value), maxItems (a list of at most value
            items), minAge (a date of birth

            at least value years ago), enum (one of the values listed in value),
            email, url, usPhoneNumber, or

            ssn (a US Social Security number).
        value:
          description: >-
            The check's parameter, for a check that takes one: a number, or for
            enum a list of values.
      description: A check a given answer must pass.
    ApplicationQuestionSurface:
      enum:
        - CORE
        - BANK_REQUIREMENTS
      type: string
      description: The part of a bank account application an answer belongs to.
    ApplicationQuestionUi:
      required:
        - label
      type: object
      properties:
        help:
          type:
            - 'null'
            - string
          description: Guidance to show alongside the question.
        label:
          type: string
          description: The label to show the applicant.
        messages:
          type:
            - 'null'
            - object
          additionalProperties:
            type: string
          description: >-
            What to tell the applicant when an answer fails a check, keyed by
            error code, e.g. REQUIRED.

            A code without an entry is left to the client's own wording.
      description: The wording to show the applicant for a question or one of its parts.
    ApplicationQuestionValue:
      required:
        - value
        - label
      type: object
      properties:
        label:
          type: string
          description: The value's label, suitable for showing to the applicant.
        value:
          type: string
          description: The value as it appears in the request body, e.g. LOAN_PROCEEDS.
      description: One value an enum answer may take.
    ApplicationRequirementsVersionStatus:
      enum:
        - PUBLISHED_NOT_YET_EFFECTIVE
        - MINIMUM
        - SUPERSEDED
        - RETIRED
      type: string
      description: Where a version of a bank's requirements stands today.
    QuestionErrorCode:
      enum:
        - REQUIRED
        - TOO_LONG
        - TOO_SHORT
        - OUT_OF_RANGE
        - BAD_FORMAT
        - NOT_IN_ENUM
        - OWNERSHIP_EXCEEDS_100
        - KYC_NOT_APPROVED
        - APPLICATION_ALREADY_PROCESSED
        - UNKNOWN_OWNER
        - BUSINESS_OWNERS_NOT_SUPPORTED
        - OWNER_TYPE_MISMATCH
      type: string
      description: >-
        Why an application question failed validation. Switch on this rather
        than on the message.
  securitySchemes:
    APPToken:
      type: oauth2
      description: Application (M2M) OAuth2 access token (client credentials).
      flows:
        clientCredentials:
          tokenUrl: /connect/token
          scopes:
            acceptor:application:read: >-
              View merchant boarding applications, including business and
              ownership details. Contains sensitive personally identifiable
              information.
            acceptor:application:secondaryapproval: >-
              Provide a secondary approval on merchant boarding and underwriting
              applications as part of a multi-step review.
            acceptor:application:write: >-
              Edit, approve, and manage merchant boarding and underwriting
              applications, and attach supporting documents.
            accounting_config:read:org: >-
              View ledger accounts, tax rates, cost centers, tags, and projects
              configured for your organization.
            accounting_config:write:org: >-
              Create and update ledger accounts, tax rates, cost centers, tags,
              and projects for your organization.
            acquiring:report:read: >-
              View transaction and settlement reports for your acquiring
              activity.
            approval_policy:read:org: >-
              View approval workflows and spending policies configured for your
              organization.
            approval_policy:write:org: >-
              Create and update approval workflows and spending policies for
              your organization.
            approval_request:create:org: >-
              Submit items for approval within your organization's approval
              workflows.
            approval_request:delete:org: Delete approval requests within your organization.
            approval_request:read:org: >-
              View pending and completed approval requests across your
              organization.
            approval_request:update:org: >-
              Edit and update existing approval requests within your
              organization.
            authorization_control:read:org: Read access to authorization control at the organization level.
            authorization_control:write:org: Write access to authorization control at the organization level.
            bank_account_application:read:org: >-
              View submitted applications to open bank accounts within your
              organization.
            bank_account_application:write:org: >-
              Submit and manage applications to open new bank accounts within
              your organization.
            bank_account:read:org: View bank account details and balances within your organization.
            bank_account:write:org: Create, update, and close bank accounts within your organization.
            beneficial_owner:read:org: >-
              View beneficial ownership information, including individuals'
              ownership stakes and identifying details.
            check_deposit:write:org: >-
              Deposit checks into bank accounts within your organization by
              submitting the check details for processing.
            comment:read:org: >-
              View comments and notes added to financial records across your
              organization.
            comment:write:org: >-
              Add and manage comments and notes on financial records across your
              organization.
            counterpart:read:org: >-
              View the suppliers and clients your organization transacts with.
              Counterparts are required before creating invoices, quotes, and
              other financial documents.
            counterpart:write:org: >-
              Add and update the suppliers and clients your organization
              transacts with. Counterparts are required before creating
              invoices, quotes, and other financial documents.
            credit_card:activate:org: >-
              Activate newly issued credit cards for use within your
              organization.
            credit_card_application:read:org: View credit card applications submitted within your organization.
            credit_card_application:write:org: >-
              Submit and manage credit card applications within your
              organization.
            credit_card:issue:org: Issue new credit cards for cardholders in your organization.
            credit_card:read:org: >-
              View credit card details and status for cards in your
              organization.
            debit_card:activate:org: >-
              Activate newly issued debit cards for use within your
              organization.
            debit_card:close:org: Permanently close debit cards in your organization.
            debit_card:issue:org: Issue new debit cards for cardholders in your organization.
            debit_card:lock:org: Lock or unlock debit cards in your organization.
            debit_card:read:org: View debit card details and status for cards in your organization.
            developer_portal: >-
              Access the Tesouro Developer Portal to view API documentation and
              manage developer resources.
            dispute:read: >-
              View payment disputes and any supporting documents attached to
              them.
            dispute:write: >-
              Accept or challenge payment disputes by uploading and submitting
              supporting evidence.
            email: ''
            expense:approve:org: >-
              Review and approve or reject expense reports submitted across your
              organization.
            expense:pay:org: Mark expense reimbursements as paid across your organization.
            expense:read:org: View expense reports and submissions across your organization.
            expense:read:self: View your own expense submissions and reports.
            expense:write:org: Create and update expense submissions across your organization.
            expense:write:self: Submit and update your own expense reports.
            export:read:org: >-
              View and download previously generated data exports for your
              organization.
            export:read:self: View and download the data exports you generated.
            export:write:org: Generate and manage data exports for your organization.
            external_bank_account:micro_deposit:org: >-
              Initiate micro-deposit verification to confirm ownership of
              external bank accounts linked to your organization.
            external_bank_account:read:org: >-
              View external bank accounts that have been linked to your
              organization.
            external_bank_account:set_verification:org: >-
              Manually set the verification status of linked external bank
              accounts, bypassing the standard verification process.
            external_bank_account:write:org: >-
              Add, update, or remove external bank accounts linked to your
              organization.
            instant_payment_limit:write:org: >-
              Set instant payment limits and limit exposure alerts for your bank
              and the organizations and bank accounts beneath it.
            invoice:read:org: View invoices issued and received across your organization.
            invoice:write:org: Create, edit, and manage invoices across your organization.
            mailbox:read:org: >-
              View the email mailboxes configured to automatically capture
              incoming invoices as payables and collect expense receipts for
              your organization.
            mailbox:write:org: >-
              Configure email mailboxes that automatically capture incoming
              invoices as payables and collect expense receipts for your
              organization.
            notification:subscription:read: >-
              View active webhook and event notification subscriptions and their
              configurations.
            notification:subscription:write: >-
              Create, update, and delete webhook and event notification
              subscriptions.
            ocr_task:read:org: >-
              View the results and status of automated receipt and invoice
              scanning tasks.
            ocr_task:write:org: >-
              Submit and manage automated receipt and invoice scanning tasks for
              your organization.
            offline_access: ''
            oidc:app:manage: >-
              Add, edit, and remove access to OIDC applications and their
              scopes.
            oidc:app:read: Read only access to the OIDC applications and their scopes
            oidc:app:write: >-
              Add and edit - but not remove - access to OIDC applications and
              their scopes
            openid: ''
            organization:read:org: View your organization's profile and general details.
            organization_settings:read:org: View configuration settings for your organization.
            organization_settings:write:org: Update configuration settings for your organization.
            organization:write:org: Update your organization's profile and general details.
            org:write:all: >-
              Enable or disable organizations on the platform. This is a
              high-privilege permission typically reserved for platform
              administrators.
            partner_portal: >-
              Access the Tesouro Partner Portal to manage your partnership
              settings and sub-merchant configurations.
            payable:approve:org: >-
              Review and approve bills and accounts payable before they are
              paid.
            payable:pay:org: >-
              Authorize and submit payments for approved bills and accounts
              payable.
            payable:read:org: View bills and accounts payable across your organization.
            payable:write:org: >-
              Create and update bills and accounts payable across your
              organization.
            payment:collect:org: >-
              Collect payments for your organization by depositing them and
              recording them against the invoices they pay.
            payment_link:write: >-
              Generate and manage shareable payment links to collect payments
              from customers.
            payment_processing: ''
            payment_rail:ach: Process payments via the ACH (Automated Clearing House) network.
            payment_rail:fednow: Process instant payments via the FedNow network.
            payment_rail:rtp: Process real-time payments via the RTP network.
            payment_record:read:org: >-
              View payment transaction history and records for your
              organization.
            payment_record:write:org: >-
              Record payments against invoices and manage their status,
              including marking payments as succeeded, cancelling, or moving
              them into processing.
            product:read:org: >-
              View the product and service catalog used for invoicing within
              your organization.
            product:write:org: >-
              Add and update products and services in your organization's
              invoicing catalog.
            profile: ''
            role:read:org: >-
              View user roles and their associated permissions within your
              organization.
            role:write:org: >-
              Create and update user roles and permission sets within your
              organization.
            transfer:write:org: Create and submit money transfers within your organization.
            underwriting:account:read: View underwriting accounts and their account event history.
            underwriting:account:write: >-
              Open maintenance reviews on underwriting accounts and close
              underwriting accounts.
            underwriting:application:approval:escalation: >-
              Provide a senior-level escalation approval on underwriting
              applications that require additional review.
            underwriting:application:approval:secondary: >-
              Provide a second-level approval on underwriting applications as
              part of a multi-step review process.
            underwriting:application:read: >-
              View underwriting applications, including sensitive business
              details and personally identifiable information.
            underwriting:application:write: >-
              Edit, approve, and manage underwriting applications and decisions,
              and attach supporting documents.
            user_profile:write:all: >-
              Update profile information for any user across all organizations.
              This is a high-privilege permission typically reserved for
              platform administrators.
            user_profile:write:self: >-
              Update your own user profile, including your name, contact
              information, and preferences.
            user:read:org: View user accounts and their details within your organization.
            user:read:self: >-
              Read access to the user's own record and the name/email of their
              direct reports.
            user:write:all: >-
              Create and manage user accounts across multiple organizations.
              This is a high-privilege permission typically reserved for
              platform administrators.
            user:write:org: Create, update, and manage user accounts within your organization.
    USERToken:
      type: oauth2
      description: User OAuth2 access token (authorization code with PKCE).
      flows:
        authorizationCode:
          authorizationUrl: /connect/authorize
          tokenUrl: /connect/token
          scopes:
            acceptor:application:read: >-
              View merchant boarding applications, including business and
              ownership details. Contains sensitive personally identifiable
              information.
            acceptor:application:secondaryapproval: >-
              Provide a secondary approval on merchant boarding and underwriting
              applications as part of a multi-step review.
            acceptor:application:write: >-
              Edit, approve, and manage merchant boarding and underwriting
              applications, and attach supporting documents.
            accounting_config:read:org: >-
              View ledger accounts, tax rates, cost centers, tags, and projects
              configured for your organization.
            accounting_config:write:org: >-
              Create and update ledger accounts, tax rates, cost centers, tags,
              and projects for your organization.
            acquiring:report:read: >-
              View transaction and settlement reports for your acquiring
              activity.
            approval_policy:read:org: >-
              View approval workflows and spending policies configured for your
              organization.
            approval_policy:write:org: >-
              Create and update approval workflows and spending policies for
              your organization.
            approval_request:create:org: >-
              Submit items for approval within your organization's approval
              workflows.
            approval_request:delete:org: Delete approval requests within your organization.
            approval_request:read:org: >-
              View pending and completed approval requests across your
              organization.
            approval_request:update:org: >-
              Edit and update existing approval requests within your
              organization.
            authorization_control:read:org: Read access to authorization control at the organization level.
            authorization_control:write:org: Write access to authorization control at the organization level.
            bank_account_application:read:org: >-
              View submitted applications to open bank accounts within your
              organization.
            bank_account_application:write:org: >-
              Submit and manage applications to open new bank accounts within
              your organization.
            bank_account:read:org: View bank account details and balances within your organization.
            bank_account:write:org: Create, update, and close bank accounts within your organization.
            beneficial_owner:read:org: >-
              View beneficial ownership information, including individuals'
              ownership stakes and identifying details.
            check_deposit:write:org: >-
              Deposit checks into bank accounts within your organization by
              submitting the check details for processing.
            comment:read:org: >-
              View comments and notes added to financial records across your
              organization.
            comment:write:org: >-
              Add and manage comments and notes on financial records across your
              organization.
            counterpart:read:org: >-
              View the suppliers and clients your organization transacts with.
              Counterparts are required before creating invoices, quotes, and
              other financial documents.
            counterpart:write:org: >-
              Add and update the suppliers and clients your organization
              transacts with. Counterparts are required before creating
              invoices, quotes, and other financial documents.
            credit_card:activate:org: >-
              Activate newly issued credit cards for use within your
              organization.
            credit_card_application:read:org: View credit card applications submitted within your organization.
            credit_card_application:write:org: >-
              Submit and manage credit card applications within your
              organization.
            credit_card:issue:org: Issue new credit cards for cardholders in your organization.
            credit_card:read:org: >-
              View credit card details and status for cards in your
              organization.
            debit_card:activate:org: >-
              Activate newly issued debit cards for use within your
              organization.
            debit_card:close:org: Permanently close debit cards in your organization.
            debit_card:issue:org: Issue new debit cards for cardholders in your organization.
            debit_card:lock:org: Lock or unlock debit cards in your organization.
            debit_card:read:org: View debit card details and status for cards in your organization.
            developer_portal: >-
              Access the Tesouro Developer Portal to view API documentation and
              manage developer resources.
            dispute:read: >-
              View payment disputes and any supporting documents attached to
              them.
            dispute:write: >-
              Accept or challenge payment disputes by uploading and submitting
              supporting evidence.
            email: ''
            expense:approve:org: >-
              Review and approve or reject expense reports submitted across your
              organization.
            expense:pay:org: Mark expense reimbursements as paid across your organization.
            expense:read:org: View expense reports and submissions across your organization.
            expense:read:self: View your own expense submissions and reports.
            expense:write:org: Create and update expense submissions across your organization.
            expense:write:self: Submit and update your own expense reports.
            export:read:org: >-
              View and download previously generated data exports for your
              organization.
            export:read:self: View and download the data exports you generated.
            export:write:org: Generate and manage data exports for your organization.
            external_bank_account:micro_deposit:org: >-
              Initiate micro-deposit verification to confirm ownership of
              external bank accounts linked to your organization.
            external_bank_account:read:org: >-
              View external bank accounts that have been linked to your
              organization.
            external_bank_account:set_verification:org: >-
              Manually set the verification status of linked external bank
              accounts, bypassing the standard verification process.
            external_bank_account:write:org: >-
              Add, update, or remove external bank accounts linked to your
              organization.
            instant_payment_limit:write:org: >-
              Set instant payment limits and limit exposure alerts for your bank
              and the organizations and bank accounts beneath it.
            invoice:read:org: View invoices issued and received across your organization.
            invoice:write:org: Create, edit, and manage invoices across your organization.
            mailbox:read:org: >-
              View the email mailboxes configured to automatically capture
              incoming invoices as payables and collect expense receipts for
              your organization.
            mailbox:write:org: >-
              Configure email mailboxes that automatically capture incoming
              invoices as payables and collect expense receipts for your
              organization.
            notification:subscription:read: >-
              View active webhook and event notification subscriptions and their
              configurations.
            notification:subscription:write: >-
              Create, update, and delete webhook and event notification
              subscriptions.
            ocr_task:read:org: >-
              View the results and status of automated receipt and invoice
              scanning tasks.
            ocr_task:write:org: >-
              Submit and manage automated receipt and invoice scanning tasks for
              your organization.
            offline_access: ''
            oidc:app:manage: >-
              Add, edit, and remove access to OIDC applications and their
              scopes.
            oidc:app:read: Read only access to the OIDC applications and their scopes
            oidc:app:write: >-
              Add and edit - but not remove - access to OIDC applications and
              their scopes
            openid: ''
            organization:read:org: View your organization's profile and general details.
            organization_settings:read:org: View configuration settings for your organization.
            organization_settings:write:org: Update configuration settings for your organization.
            organization:write:org: Update your organization's profile and general details.
            org:write:all: >-
              Enable or disable organizations on the platform. This is a
              high-privilege permission typically reserved for platform
              administrators.
            partner_portal: >-
              Access the Tesouro Partner Portal to manage your partnership
              settings and sub-merchant configurations.
            payable:approve:org: >-
              Review and approve bills and accounts payable before they are
              paid.
            payable:pay:org: >-
              Authorize and submit payments for approved bills and accounts
              payable.
            payable:read:org: View bills and accounts payable across your organization.
            payable:write:org: >-
              Create and update bills and accounts payable across your
              organization.
            payment:collect:org: >-
              Collect payments for your organization by depositing them and
              recording them against the invoices they pay.
            payment_link:write: >-
              Generate and manage shareable payment links to collect payments
              from customers.
            payment_processing: ''
            payment_rail:ach: Process payments via the ACH (Automated Clearing House) network.
            payment_rail:fednow: Process instant payments via the FedNow network.
            payment_rail:rtp: Process real-time payments via the RTP network.
            payment_record:read:org: >-
              View payment transaction history and records for your
              organization.
            payment_record:write:org: >-
              Record payments against invoices and manage their status,
              including marking payments as succeeded, cancelling, or moving
              them into processing.
            product:read:org: >-
              View the product and service catalog used for invoicing within
              your organization.
            product:write:org: >-
              Add and update products and services in your organization's
              invoicing catalog.
            profile: ''
            role:read:org: >-
              View user roles and their associated permissions within your
              organization.
            role:write:org: >-
              Create and update user roles and permission sets within your
              organization.
            transfer:write:org: Create and submit money transfers within your organization.
            underwriting:account:read: View underwriting accounts and their account event history.
            underwriting:account:write: >-
              Open maintenance reviews on underwriting accounts and close
              underwriting accounts.
            underwriting:application:approval:escalation: >-
              Provide a senior-level escalation approval on underwriting
              applications that require additional review.
            underwriting:application:approval:secondary: >-
              Provide a second-level approval on underwriting applications as
              part of a multi-step review process.
            underwriting:application:read: >-
              View underwriting applications, including sensitive business
              details and personally identifiable information.
            underwriting:application:write: >-
              Edit, approve, and manage underwriting applications and decisions,
              and attach supporting documents.
            user_profile:write:all: >-
              Update profile information for any user across all organizations.
              This is a high-privilege permission typically reserved for
              platform administrators.
            user_profile:write:self: >-
              Update your own user profile, including your name, contact
              information, and preferences.
            user:read:org: View user accounts and their details within your organization.
            user:read:self: >-
              Read access to the user's own record and the name/email of their
              direct reports.
            user:write:all: >-
              Create and manage user accounts across multiple organizations.
              This is a high-privilege permission typically reserved for
              platform administrators.
            user:write:org: Create, update, and manage user accounts within your organization.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.