> ## Documentation Index > Fetch the complete documentation index at: https://docs2.finverse.com/llms.txt > Use this file to discover all available pages before exploring further. # Get account number > Retrieve account number information for a specific account (using a specific `account_id`). **Authorization**: `login_identity_token` ### account Full `account` object, containing account-level balances & metadata for the requested account. See `GET /accounts` for details ### account_number Full `account_number` object, containing account number details for the requested account. ### institution Summary Institutions object. See `GET /institutions` for details. ### login_identity Summary Login Identity object. See `GET /login_identity` for details. ### payment_details Full `payment_details` array, containing bank routing details for the requested account. ## OpenAPI ````yaml /api-reference/openapi.json get /account_numbers/{accountId} openapi: 3.0.0 info: description: Documentation of the early finverse services title: Finverse Public termsOfService: https://example.com contact: name: Maintainers email: info@finverse.com license: name: unknown license version: 0.0.1 servers: - url: https://api.prod.finverse.net security: - Oauth2: - test tags: - name: public description: Publicly accessible endpoints x-group: Public - name: customer description: Customer app and institution endpoints x-group: Customer - name: link description: Finverse Link flows x-group: Link - name: login_identity description: Login identity lifecycle and metadata x-group: Login identity - name: accounts description: Accounts, balances, and account numbers x-group: Accounts - name: statements description: Statements and composite statements x-group: Statements - name: transactions description: Transaction history x-group: Transactions - name: identity_income description: Identity and income insights x-group: Identity & income - name: payment_links description: Payment link creation and checkout x-group: Payment links - name: mandates description: Direct debit mandates x-group: Mandates - name: payments description: Payment initiation and status x-group: Payment operations - name: payouts description: Payouts and scheduled payouts x-group: Payouts - name: payment_users description: Payment user profiles x-group: Payment users - name: payment_accounts description: Payment accounts for users x-group: Payment accounts - name: payment_methods description: Stored payment methods x-group: Payment methods - name: bills description: Bill presentment x-group: Bills - name: disputes description: Payment disputes x-group: Disputes - name: ledger description: Ledger and statements x-group: Ledger paths: /account_numbers/{accountId}: get: tags: - accounts summary: Get account number description: >- Retrieve account number information for a specific account (using a specific `account_id`). **Authorization**: `login_identity_token` ### account Full `account` object, containing account-level balances & metadata for the requested account. See `GET /accounts` for details ### account_number Full `account_number` object, containing account number details for the requested account. ### institution Summary Institutions object. See `GET /institutions` for details. ### login_identity Summary Login Identity object. See `GET /login_identity` for details. ### payment_details Full `payment_details` array, containing bank routing details for the requested account. operationId: getAccountNumber parameters: - description: The account id name: accountId in: path required: true schema: type: string responses: '200': description: Successful content: application/json: schema: $ref: '#/components/schemas/GetAccountNumberResponse' examples: success: summary: Success value: account: account_currency: HKD account_id: 01FEFKRGCTNYMSTDZWM6WFZVZS account_name: HKD Checking balance: currency: HKD raw: '70013.12' value: 70013.12 created_at: '2021-09-01T02:42:12.000Z' group_id: 01FEFKRGDB5NBPKRQA4CB7HJ30 is_closed: false is_excluded: false is_parent: false statement_balance: currency: HKD raw: '70013.12' value: 70013.12 updated_at: '2021-09-01T02:42:12.000Z' account_number: account_id: 01FEFKRGCTNYMSTDZWM6WFZVZS number: '405123456789' raw: 405-123456-789 institution: countries: - HKG institution_id: hsbc-hk institution_name: HSBC (HK) - Personal portal_name: HSBC Personal Account login_identity: login_identity_id: 01FEFKR1GSJCRDHEN0FZ3DG9GF status: DATA_RETRIEVAL_COMPLETE payment_details: - bank_address: Head Office, 1 Queen's Road Central, Hong Kong bank_country: Hong Kong bank_fullname: The Hongkong and Shanghai Banking Corporation Limited bank_shortname: HSBC (Hong Kong) bic: HSBCHKHHHKH format: SWIFT other_info: {} '400': description: Invalid Request content: application/json: schema: $ref: '#/components/schemas/BadRequestModelV2' examples: numbers_not_found: summary: Error (numbers not found) value: error: code: 40004 error_code: ACCOUNT_NUMBERS_UNAVAILABLE message: >- No account numbers are associated with the requested account(s). We may not be able to retrieve account numbers for this account type, or there may have been an error retrieving account numbers for this account (please review product_status for details). request_id: '{account_id}' type: API_ERROR product_not_supported: summary: Error (product not supported) value: error: code: 40012 details: Account numbers are not supported for this bank error_code: PRODUCT_NOT_SUPPORTED message: >- Requested product is not yet supported for this institution. Please refer to Institutions list for details on products supported. request_id: '{unique_id}' type: API_ERROR account_not_found: summary: Error (Account not found) value: error: code: 40004 error_code: ACCOUNT_NOT_FOUND message: >- account_id cannot be found. Resource does not exist, has been deleted, or is no longer accessible. request_id: '{unique_id}' type: API_ERROR '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/BadRequestModelV2' security: - Oauth2: - account_number components: schemas: GetAccountNumberResponse: properties: account: $ref: '#/components/schemas/Account' account_number: $ref: '#/components/schemas/AccountNumber' institution: $ref: '#/components/schemas/InstitutionShort' login_identity: $ref: '#/components/schemas/LoginIdentityShort' payment_details: type: array items: $ref: '#/components/schemas/PaymentDetails' BadRequestModelV2: properties: error: type: object required: - type - code - error_code - message - request_id properties: code: type: integer example: 40004 details: type: string error_code: type: string example: CREDENTIALS_INVALID message: type: string request_id: description: The request_id provided in the request header type: string type: description: The error type type: string enum: - LINK_ERROR - API_ERROR example: LINKING_ERROR Account: required: - is_parent - is_closed - is_excluded - account_id - account_name - group_id - metadata properties: account_currency: type: string example: HKD description: >- Currency of the account (e.g. USD). Usually available, but may be null for zero-balance accounts (e.g. multi-currency or time-deposit account with zero balance). account_holder_name: type: string example: John Doe description: >- (Deprecated) Account holder name (if provided by the institution). Replaced by GET /identity. account_id: type: string example: 01ARZ3NDEKTSV4RRFFQ69G5FAV description: >- Finverse account ID. This is deterministically computed, such that the same account record provided by an institution across 2 or more data retrieval sessions will always have the same `account_id`. account_name: type: string example: HKD Savings description: End-user recognizable name for the account. account_nickname: type: string example: Emergency Fund description: >- Nickname for the account (if provided by the instiution). This is typically a custom account name set by the end-user. account_number_masked: type: string example: 123XXXXXX89 description: >- Masked account number. Format: preserves original length; shows first 0-4 digits + last 2-4 digits in plain text (depending on original length); omits spaces/symbols. account_sub_type: type: string example: TIME_DEPOSIT account_type: $ref: '#/components/schemas/AccountType' description: '**Beta**: account type object' balance: $ref: '#/components/schemas/CurrencyAmount' description: Balance object, in the account_currency country: type: string example: HKG description: 3-letter country code for the account (e.g. "HKG") created_at: type: string format: date-time description: >- Timestamp for when the account's record was first written to Finverse's database. group_id: description: >- ID used to identify a group of related parent + sub-accounts. This is deterministically computed based on the shared account number of the related accounts. type: string example: 03504faef9ad3ac048c6a43efa6db7ba1c5239a856536839d87ac949559e7ceb is_closed: type: boolean example: false description: Reserved for future use. is_excluded: type: boolean example: false description: Reserved for future use. is_parent: type: boolean example: false description: >- Flag for parent/master accounts (e.g. "Integrated Account" in Hong Kong). To avoid showing duplicate accounts, we recommend disregarding parent account data and referring instead to associated sub-accounts (using `group_id`). ledger_balance: $ref: '#/components/schemas/CurrencyAmount' metadata: type: object additionalProperties: type: string description: >- **Beta**: Metadata object, containing additional account information (for some institutions only) statement_balance: $ref: '#/components/schemas/CurrencyAmount' description: >- Balance object, in the institution's reporting or statement currency (if provided by the institution). E.g. balance in HKD for a USD Savings account at a Hong Kong bank. If not provided by the institution, the `statement_balance` will be same as `balance`. updated_at: type: string format: date-time description: Timestamp of the last update to the account's record. AccountNumber: required: - account_id - raw properties: account_id: type: string example: 01ARZ3NDEKTSV4RRFFQ69G5FAV description: Finverse account ID (see `GET /accounts`) number: type: string example: '1234567890123' description: >- Account number provided by the institution (omitting any spaces/symbols) raw: type: string example: 123-4567890-123 description: >- Raw account number, in it's original format (as reported by the institution) InstitutionShort: properties: countries: type: array items: type: string example: - HKG institution_id: type: string example: 123 institution_name: type: string example: Mock Bank portal_name: type: string example: Personal Internet Banking LoginIdentityShort: properties: last_session_id: type: string format: ulid login_identity_id: type: string format: ulid status: type: string example: LINKING PaymentDetails: properties: bank_address: type: string example: 99 Stree, Building, City description: Institution's address (typically of the head office. bank_country: type: string example: Country description: Institution's country (e.g. "Singapore") bank_fullname: type: string example: Finverse test bank description: Institution's full legal name. bank_shortname: type: string example: testbank description: Institution's short name / business name. bic: type: string example: BKCHHKHHXXX description: Institution's BIC code. format: type: string example: SWIFT description: 'Type of BIC code provided. Possible values: `SWIFT`.' other_info: $ref: '#/components/schemas/OtherInfo' description: >- Additional routing details for the institution (e.g. local bank/branch code). Reserved for future use. AccountType: properties: subtype: type: string enum: - CURRENT - SAVINGS - TIME_DEPOSIT - OTHER - CREDIT_CARD - DEBIT_CARD - SECURITIES - FUNDS - STOCKS - BONDS - MORTGAGE - PERSONAL_LOAN - REVOLVING_LOAN - UNKNOWN example: SAVINGS description: >- Secondary classification of the account. Possible values: `BONDS`, `CURRENT`, `CREDIT_CARD`, `DEBIT_CARD`, `FUNDS`, `MORTGAGE`, `PERSONAL_LOAN`, `RETIREMENT`,`REVOLVING_LOAN`, `SAVINGS`, `SECURITIES`, `STOCKS`, `TIME_DEPOSIT`, `OTHER`, `UNKNOWN` type: type: string enum: - DEPOSIT - CARD - INVESTMENT - LOAN - UNKNOWN example: DEPOSIT description: >- Primary classification of the account. Possible values: `CARD`, `DEPOSIT`, `INVESTMENT`, `LOAN`, `OTHER`, `UNKNOWN` CurrencyAmount: required: - value properties: currency: type: string example: HKD description: >- Currency of the `value`. Usually available, but may be null if value is 0 raw: type: string example: '69.00' description: >- Raw amount (as reported by the institution). Usually available, but may be null if value is 0. Intended for QA only value: $ref: '#/components/schemas/FvDecimal' description: >- Amount. Sign follows financial statement conventions (positive sign: assets / money in; negative sign: liabilities / money out) OtherInfo: properties: bank_code: type: string FvDecimal: type: number x-go-type: embedded: true import: package: gitlab.com/finverse/gitops/applications/common-go/amount type: FvDecimal securitySchemes: Oauth2: type: oauth2 flows: clientCredentials: tokenUrl: https://finverse-dev.us.auth0.com/oauth/token scopes: account: Account balance: Balance credit: Credit institution: Institution investment: Investment link: Link test: Test transaction: Transaction ````