--- title: "Get account information" method: GET path: "/accounts/{accountId}" tags: ["Accounts"] --- # Get account information `GET /accounts/{accountId}` The `GET /accounts/{accountId}` endpoint retrieves the information for a specific bank account. ## Path parameters - `accountId` string ## Headers - `on-behalf-of` string, required - `token-customer-ip-address` string, ipv4 ## Response `200` Successful response - GetAccountResponse — Operation completed successfully. - `account` Account — Contains information about the requested bank account. - `accountDetails` AccountDetails — Contains the details needed to identify, correlate and validate the bank account. - `accountHolderName` string — The name of the account holder/owner. - `bic` string — The Business Identifier Code (BIC), ISO 9362, is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned. It uniquely identifies the name and country, (and sometimes the branch) of the bank involved. BICs are often called SWIFT Codes and can be either 8 or 11 characters long." - `identifier` string, required — The type of `accountIdentifier` being used, e.g., bban, gbDomestic, iban, msisdn, pan or token. The `identifier` is displayed if an account is returned by the bank. - `accountIdentifiers` AccountIdentifier[], required — The account numbers and other strings that identify this as a unique bank account. The `accountidentifiers` are displayed if an account is returned by the bank - union — Account numbers and other strings that identify this as a unique bank account. - object - `bankgiro` AccountIdentifierBankgiro, required — The identifier for domestic bank accounts in Sweden. - … - object - `bban` AccountIdentifierBban, required - … - object - `gbDomestic` AccountIdentifierGbDomestic, required — A domestic bank account in the UK. - … - object - `iban` AccountIdentifierIban, required — The International Bank Account Number, used when sending interbank transfers or wiring money from one bank to another, especially across international borders. - … - object - `msisdn` AccountIdentifierMsisdn, required — The Mobile Station International Subscriber Director Number (MSISDN) is the user's mobile phone number, used as a unique identifier to enable routing of voice and SMS traffic to and from a specific subscription/device on a wireless/mobile network. - … - object - `pan` AccountIdentifierPan, required — The Primary Account Number (PAN). The card identifier found on payment cards, such as credit cards and debit cards, as well as stored-value cards, gift cards and other similar card, sometimes referred to as a bank card number. - … - object - `plusgiro` AccountIdentifierPlusgiro — The domestic transaction clearing system in Sweden. The credit transfer function, which is part of Nordea, and used for mediating payments between accounts held by companies and individuals. - … - object - `token` AccountIdentifierToken, required — The primary account number; the card identifier found on payment cards, such as credit cards and debit cards, as well as stored-value cards, gift cards and other similar card, sometimes referred to as a bank card number. - … - `metadata` AccountDetailsMetadataEntry[] — Additional fields returned by the bank in response to your particular request. The presence and type of metadata are dependent on the bank and generally comprise additional information about the account or the transaction pertinent to your specific use case. You define how this information is used when included in the bank's response. - `ProviderAccountDetails` union — Specific information regarding the bank required by the respective Open Banking API standard adopted (CMA9, NextGenPSD2, PolishAPI, or STET). - object - `cma9AccountDetails` Cma9AccountDetails — Provider account details required under the CMA9 API standard. - `accountType` 'INVALID_ACCOUNT_TYPE' | 'BUSINESS_ACCOUNT' | 'PERSONAL_ACCOUNT' — Specifies the type of account. - `accountSubtype` 'INVALID_ACCOUNT_SUBTYPE' | 'CHARGE_CARD' | 'CREDIT_CARD' | 'CURRENT_ACCOUNT' | 'EMONEY' | 'LOAN' | 'MORTGAGE' | 'PREPAID_CARD' | 'SAVINGS' — This specifies the sub type of the account. - `address` Cma9AccountDetailsAddress[] - … - `description` string — A description of the account type. - `emailAddress` string — The electronic mail address associated with the account. - `mobile` string — The mobile phone number associated with the account. - `name` string — Name of the account, as assigned by the account servicing institution. The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. - `partyId` string — The unique and immutable identifier used to identify the TPP resource; this identifier has no meaning to the account owner. - `partyNumber` string — The number assigned by an agent to identify its customer. - `partyType` 'INVALID_PARTY_TYPE' | 'DELEGATE' | 'JOINT' | 'SOLE' — The party type, in a coded form. - `phone` string — The collection of information that identifies a phone number, as defined by the telecom service. - object - `nextGenPsd2AccountDetails` NextGenPsd2AccountDetails — Provider account details required under the NextGenPSD2 standard. - `cashAccountType` string — The `ExternalCashAccountType1Code` from the ISO 20022 code. - `currency` string — The ISO 4217 three letter currency code. - `details` string — The details provided by the bank regarding characteristics of the account or characteristics of the relevant card. - `linkedAccounts` string — In the case of a set of pending card transactions, the relevant cash account the card is set up on; this is the same as the `resourceId` of the relevant cash account. - `product` string — The bank-defined product name for this account; the proprietary definition. - `usage` string — Specifies the usage of the account (PRIV = private personal account, ORGA = professional account). - object - `polishApiAccountDetails` PolishApiAccountDetails — The provider account details required under the Polish API standard. - `accountHolderType` 'INVALID_ACCOUNT_HOLDER_TYPE' | 'INDIVIDUAL' | 'CORPORATION' — Specifies the type of account holder. - `accountNameClient` string — Account nickname set by the account holder. - `auxData` PolishApiAccountDetailsAuxDataEntry — The bank-defined auxiliary data associated with the account. - `bank` PolishApiBankAccountInfo — Specifies information about the bank itself. - … - `currency` string — The ISO 4217 three letter currency code. - `nameAddress` PolishApiNameAddress — Doing Business As (DBA) and/or other names and addresses of the company. - … - `psuRelations` PolishApiAccountPsuRelation[] — The bank-provided information concerning the relationship between the user and an account. - … - object - `stetAccountDetails` StetAccountDetails — The provider account details required under the French PSD2 API standard. - `accountId` StetAccountIdentification — Bank-defined account identifiers. - … - `cashAccountType` string — Specifies the type of account. - `details` string — The bank-defined characteristics of the account or characteristics of the card. - `linkedAccount` string — The relevant cash account that the card is set up on. - `product` string — The bank-defined product name for this account; the proprietary definition. - `psuStatus` string — The relationship between the user and the account; e.g., Account Holder, Co-account Holder, Attorney. - `usage` string — Specifies the usage of the account (PRIV = private personal account, ORGA = professional account). - `status` string — Specifies the bank-defined status of the account (open, closed, active, inactive, etc.) - `type` AccountDetailsAccountType[], required — Specifies the type of account. The `type` is displayed if an account is returned by the bank - `currency` string — The ISO 4217 three letter currency code. The `currency` is displayed if an account is returned by the bank - `accountFeatures` AccountFeatures — Open Banking features supported for this account. - `supportsInformation` boolean — An account available for AIS operations. - `supportsReceivePayment` boolean — An account that can receive money transfers. - `supportsSendPayment` boolean — An account that can send money transfers. - `bankId` string, required — The Token.io id of the bank where the consent is created. **This field is required if the customer is not using Token.io's Hosted Pages for bank selection, i.e., API-only integration when `EMBEDDED_HOSTED_PAGES` is selected in `flowType`, or Hosted Pages embedded (modal) integration.** - `id` string, required — The system-generated, unique identifier for this account. - `isLocked` boolean — All services are locked out for this account if `isLocked` = true. This setting is only used in conjunction with the legacy Token.io mobile app. The account will be locked if, for example, the user has lost their phone. Instead of removing the account, Token.io locks it so that the user can still see the account after recovery. A re-linking is enforced before the account can be used again. - `name` string — The unique name of this account. ## Other responses - `400` — The client specified an invalid argument - `401` — The authorization information is missing or invalid - `403` — Permission to access this endpoint is denied - `404` — The requested entity, such as a payment, was not found - `429` — Too many requests - `500` — An unexpected or internal server error - `501` — The operation was not implemented - `503` — Service is unavailable - `504` — Gateway has timed out --- [API](https://skmtc.net/token/apis/token-io-s-open-banking-api-for-tpps.md) · [All operations](https://skmtc.net/token/apis/token-io-s-open-banking-api-for-tpps/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/token/token-io-s-open-banking-api-for-tpps/versions/5e8d6d2c24a1/schema)