--- title: "Get an Account by AccountId" method: GET path: "/accounts/{AccountId}" tags: ["Accounts"] --- # Get an Account by AccountId `GET /accounts/{AccountId}` Enables an AISP to retrieve information about a specific PSU account. ## Path parameters - `AccountId` string, required ## Headers - `x-fapi-auth-date` string - `x-fapi-customer-ip-address` string - `x-fapi-interaction-id` string - `Authorization` string, required - `x-customer-user-agent` string - `x-client-id` string ## Response `200` Accounts Read - OBReadAccount6 - `Data` object, required - `Account` OBAccount6[] - `AccountId` string, required — A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. - `Status` 'Deleted' | 'Disabled' | 'Enabled' | 'Pending' | 'ProForma' — Specifies the status of account resource in code form.
For a full list of enumeration values refer to `OBInternalAccountStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - `StatusUpdateDateTime` string, date-time — Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 - `Currency` string — Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account. - `AccountCategory` 'Business' | 'Personal' — Specifies the type of account (personal or business).
For a full list of enumeration values refer to 'OBInternalAccountType1Code' in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - `AccountTypeCode` 'CACC' | 'CARD' | 'CASH' | 'CHAR' | 'CISH' | 'COMM' | 'CPAC' | 'LLSV' | 'LOAN' | 'MGLD' | 'MOMA' | 'NREX' | 'ODFT' | 'ONDP' | 'OTHR' | 'SACC' | 'SLRY' | 'SVGS' | 'TAXE' | 'TRAN' | 'TRAS' | 'VACC' | 'NFCA' | 'MORT' | 'WALT' — Specifies the sub type of account (product family group)
For a full list of enumeration values refer to `OBExternalCashAccountType1Code` *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - `Description` string — Specifies the description of the account type. - `Nickname` string — The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account. - `OpeningDate` string, date-time — Date on which the account and related basic services are effectively operational for the account owner. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 - `MaturityDate` string, date-time — Maturity date of the account. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 - `SwitchStatus` string — Specifies the switch status for the account, in a coded form.
For a full list of enumeration values refer to `OBInternalSwitchStatusCode` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - `Account` object[] - `SchemeName` string, required — Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - `Identification` string, required — Identification assigned by an institution to identify an account. This identification is known by the account owner. - `Name` string — The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account. - `LEI` string — Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". - `SecondaryIdentification` string — This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). - `StatementFrequencyAndFormat` object[] - `Frequency` 'YEAR' | 'DAIL' | 'INDA' | 'MNTH' | 'QURT' | 'MIAN' | 'TEND' | 'MOVE' | 'WEEK' | 'NONE' | 'SLCT' — For a full list of enumeration values refer to `OBFrequency2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_internal_CodeSets) - `CommunicationMethod` 'EMAL' | 'FAXI' | 'FILE' | 'ONLI' | 'POST' — For a full list of enumeration values see `OBExternalCommunicationMethod2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_internal_CodeSets) - `Format` 'DPDF' | 'DXML' | 'SDSH' | 'WORD' | 'XSLT' | 'DCSV' — For a full list of enumeration values refer to `ExternalDocumentFormat1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_internal_CodeSets) - `DeliveryAddress` OBPostalAddress7 — Information that locates and identifies a specific address, as defined by postal services. - `AddressType` 'BIZZ' | 'DLVY' | 'MLTO' | 'PBOX' | 'ADDR' | 'HOME' | 'CORR' | 'STAT' — Identifies the nature of the postal address.
For a full set of codes see `OBAddressType2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets). - `Department` string — Identification of a division of a large organisation or building. - `SubDepartment` string — Identification of a sub-division of a large organisation or building. - `StreetName` string — Name of a street or thoroughfare. - `BuildingNumber` string — Number that identifies the position of a building on a street. - `BuildingName` string — Name of a referenced building. - `Floor` string — Number that identifies the level within a building - `UnitNumber` string — Number that identifies the unit of a specific address . - `Room` string — Information that locates and identifies a room to form part of an address - `PostBox` string — Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for. - `TownLocationName` string — Name of a built-up area, with defined boundaries, and a local government. - `DistrictName` string — Number that of the regional area, known as a district, which forms part of an address - `CareOf` string — The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual. - `PostCode` string — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. - `TownName` string — Name of a built-up area, with defined boundaries, and a local government. - `CountrySubDivision` string — Identifies a subdivision of a country such as state, region, county. - `Country` string — Nation with its own government. - `AddressLine` string[] - `Servicer` OBBranchAndFinancialInstitutionIdentification50 — Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. - `SchemeName` string, required — Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer to `OBInternalFinancialInstitutionIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) - `Identification` string, required — Unique and unambiguous identification of the servicing institution. - `Name` string — Name by which an agent is known and which is usually used to identify that agent. - `Links` Links — Links relevant to the payload - `Self` string, uri, required - `First` string, uri - `Prev` string, uri - `Next` string, uri - `Last` string, uri - `Meta` Meta — Meta Data relevant to the payload - `TotalPages` integer - `FirstAvailableDateTime` string, date-time — All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 - `LastAvailableDateTime` string, date-time — All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 ## Other responses - `400` — Bad request - `401` — Unauthorized - `403` — Forbidden - `405` — Method Not Allowed - `406` — Not Acceptable - `429` — Too Many Requests - `500` — Internal Server Error --- [API](https://skmtc.net/openbankinguk/apis/account-and-transaction-api-specification.md) · [All operations](https://skmtc.net/openbankinguk/apis/account-and-transaction-api-specification/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openbankinguk/account-and-transaction-api-specification/revisions/b1c449c8ecb0/schema)