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

# Batch reveal bank account numbers

> Returns the full account numbers of up to 100 bank accounts, in the order requested. Available to server credentials only, once Nmbr has enabled it for your partner account.



## OpenAPI

````yaml /spec/openapi.json post /bank_accounts/batch/reveal
openapi: 3.0.0
info:
  title: Nmbr API
  description: API to interact with Nmbr Payroll
  version: 1.0.0
servers:
  - url: https://sandbox.nmbr.co/services/payroll
security:
  - CompanyToken: []
tags:
  - name: Accounting Codes
  - name: Accounting Code Rules
  - name: Adjustments
  - name: Allowances
  - name: Allowance Line Items
  - name: Allowance Types
  - name: Async Tasks
  - name: Bank Accounts
  - name: Business Entities
  - name: Business Entity Verifications
  - name: Business Entity ROE Authorizations
  - name: Business Presets
  - name: Calculations
  - name: Companies
  - name: Contractors
  - name: Deductions
  - name: Deduction Line Items
  - name: Deduction Types
  - name: Earnings
  - name: Earning Line Items
  - name: Earning Types
  - name: Effective Tax Properties
  - name: Employees
  - name: Employee Benefits
  - name: Employee Benefit Line Items
  - name: Employee Benefit Types
  - name: Employer Benefits
  - name: Employer Benefit Line Items
  - name: Employer Benefit Types
  - name: Employer Statutory Withholding Line Items
  - name: Employer Statutory Withholding Types
  - name: Forms
  - name: Form Batches
  - name: Form Types
  - name: Holidays
  - name: Integrations
  - name: Journal Entries
  - name: Overtime Rates
  - name: Partners
  - name: Pay Rates
  - name: Pay Schedules
  - name: Pay Splits
  - name: Pay Stubs
  - name: Payments
  - name: Payrolls
  - name: Reimbursements
  - name: Reimbursement Line Items
  - name: Reimbursement Types
  - name: Remittance Accounts
  - name: Remittance Account Enrollments
  - name: Remittance Totals
  - name: Reports
  - name: ROE SAT Agreements
  - name: Statutory Withholding Line Items
  - name: Statutory Withholding Types
  - name: Tags
  - name: Tag Groups
  - name: Tax Properties
  - name: Tax Property Templates
  - name: Tokens
  - name: Usage Records
  - name: Usage Summaries
  - name: Users
  - name: Vacation Pay
  - name: Vacation Pay Settings
  - name: Webhooks
  - name: Work Assignments
paths:
  /bank_accounts/batch/reveal:
    post:
      tags:
        - Bank Accounts
      summary: Batch reveal bank account numbers
      description: >-
        Returns the full account numbers of up to 100 bank accounts, in the
        order requested. Available to server credentials only, once Nmbr has
        enabled it for your partner account.
      operationId: bank-accounts-batch-reveal
      requestBody:
        content:
          application/json:
            schema:
              type: array
              description: >-
                The IDs of the bank accounts to reveal, up to 100 per request.
                If any ID doesn't exist, the request fails with a `422` and no
                account numbers are returned.
              items:
                type: string
              minItems: 1
              maxItems: 100
            example:
              - <id>
              - <id>
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BankAccount'
              example:
                data:
                  - id: <id>
                    object: bank_account_reveal
                    data:
                      account_number: '3654916'
                  - id: <id>
                    object: bank_account_reveal
                    data:
                      account_number: '3654916'
components:
  schemas:
    BankAccount:
      type: object
      title: Bank Account
      properties:
        business_entity:
          type: object
          description: >-
            The Business Entity that owns this bank account. Present only for
            Business Entity bank accounts.
          properties:
            id:
              type: string
              description: The unique identifier of the object in Nmbr.
              readOnly: true
            object:
              type: string
              description: The type of the object in Nmbr (`"business_entity"`).
              readOnly: true
        name:
          type: string
          description: >-
            An optional human-readable label for the bank account, such as "Main
            chequing". Useful for distinguishing accounts at the same
            institution.
          nullable: true
          maxLength: 255
        institution_number:
          type: string
          description: >-
            The 3-digit bank institution number. An institution Nmbr does not
            hold raises a `bank_account_unrecognized_institution` warning rather
            than failing the request.
        institution_name:
          type: string
          description: >-
            The name of the banking institution matching the institution number,
            or `null` if the number is not recognized. Always the English name;
            see `institution_name_translated` for the value in the request's
            locale.
          nullable: true
        institution_name_translations:
          type: object
          nullable: true
          properties:
            en:
              type: string
              nullable: true
            fr:
              type: string
              nullable: true
        institution_name_translated:
          type: string
          description: >-
            The translation of the `institution_name` property for the request
            locale. Computed using the values in `institution_name` and
            `institution_name_translations` and the value of the request's
            `Accept-Language` header.
          readOnly: true
        transit_number:
          type: string
          description: >-
            The 5-digit bank transit number. A transit that is not a known
            branch of the given institution raises a
            `bank_account_unrecognized_transit` warning rather than failing the
            request.
        transit_address:
          type: string
          description: >-
            The address of the branch matching the institution and transit
            numbers, or `null` if the pair is not recognized.
          nullable: true
        account_number_last_3:
          type: string
          description: The last 3 digits of the bank account number.
          nullable: true
        is_primary:
          type: boolean
          description: Whether this is the primary bank account for its owner.
        is_deletable:
          type: boolean
          description: Whether this bank account can be deleted.
        warnings:
          type: object
          description: >-
            A collection of data validation warnings for this bank account.
            Warnings indicate incomplete or potentially incorrect data, such as
            an unrecognized institution or transit number.
          nullable: true
          properties:
            object:
              type: string
              nullable: true
            data:
              type: object
              nullable: true
        is_pad_signed:
          type: boolean
          description: >-
            Whether a PAD agreement has been signed. Only present for Business
            Entity bank accounts.
        pad_signer_name:
          type: string
          description: >-
            The name of the person who signed the PAD agreement. Only applicable
            to Business Entity bank accounts.
          nullable: true
          maxLength: 255
        pad_signer_email:
          type: string
          description: >-
            The email address of the PAD agreement signer. Only applicable to
            Business Entity bank accounts.
          nullable: true
          maxLength: 255
        pad_signer_title:
          type: string
          description: >-
            The title or role of the PAD agreement signer. Only applicable to
            Business Entity bank accounts.
          nullable: true
          maxLength: 255
        pad_signed_at:
          type: string
          description: >-
            The date and time the PAD agreement was signed. Only applicable to
            Business Entity bank accounts.
          readOnly: true
          nullable: true
          format: dateTime
        pad_file:
          description: >-
            The signed PAD agreement file. Only present for Business Entity bank
            accounts.
        created_at:
          type: string
          description: The date and time the object was created in Nmbr.
          readOnly: true
          format: dateTime
        updated_at:
          type: string
          description: The date and time the object was last updated in Nmbr.
          readOnly: true
          format: dateTime
  securitySchemes:
    CompanyToken:
      type: http
      scheme: bearer

````

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