---
title: "Get account"
method: GET
path: "/financial-data/v2/accounts/{id}"
tags: ["Accounts"]
---

# Get account

`GET /financial-data/v2/accounts/{id}`

Retrieve a specific account.

## Path parameters

- `id` string, required

## Response `200`

An account.

- Account
  - `id` string, required — Unique resource identifier.
  - `organizationId` string, required — Unique resource identifier for an Organization.
  - `thirdPartyId` string, required — ID of the associated third-party, e.g. the bank in which the account is held.
  - `affiliationId` string, required — ID of the affiliation. An affiliation is and describes the relationship between the legal entity (`entityId`) owning this account and the third-party (`thirdPartyId`) where the account is held (e.g. a bank).
  - `entityId` string, required — ID of the associated legal Entity.
  - `market` string, required — Two-letter ISO 3166-1 alpha2 country code.
  - `currency` string, required — Three-letter ISO 4217 currency code.
  - `name` string, required — Name of the account automatically populated by Atlar.
  - `alias` string — An additional name, an alias, for the account.
  - `identifiers` AccountIdentifier[], required
    - `type` 'IBAN' | 'NUMBER' | 'ADYEN' | 'AU_BPAY_BILLER_CODE' | 'DK_FIK' | 'INVESTMENT_NUMBER' | 'NATIONAL_ID_NUMBER' | 'PAYPAL' | 'PROPRIETARY' | 'SE_BANKGIRO' | 'SE_PLUSGIRO' | 'SOLDO' | 'WALLET_ADYEN_BALANCE_PLATFORM' | 'WALLET_AIRWALLEX' | 'WALLET_CURRENCYCLOUD' | 'WALLET_FLASH_PAYMENTS' | 'WALLET_FREEMARKET' | 'WALLET_HYPERWALLET' | 'WALLET_INPAY' | 'WALLET_LEAD' | 'WALLET_MERCURY' | 'WALLET_MONEYCORP' | 'WALLET_PAYHAWK' | 'WALLET_REVOLUT' | 'WALLET_SKRILL' | 'WALLET_STRIPE' | 'WALLET_SWISSQUOTE', required — Account Identifier type. Choose among: <ul> <li><code>IBAN</code> — IBAN</li> <li><code>NUMBER</code> — Account number</li> <li><code>ADYEN</code> — Adyen identifier</li> <li><code>AU_BPAY_BILLER_CODE</code> — Australian BPAY Biller Code</li> <li><code>DK_FIK</code> — FIK creditor number</li> <li><code>INVESTMENT_NUMBER</code> — Investment number</li> <li><code>NATIONAL_ID_NUMBER</code> — National Identification Number</li> <li><code>PAYPAL</code> — PayPal wallet identifier</li> <li><code>PROPRIETARY</code> — Proprietary identifier</li> <li><code>SE_BANKGIRO</code> — <a href="https://www.bankgirot.se/en/">Bankgiro number</a></li> <li><code>SE_PLUSGIRO</code> — <a href="https://www.nordea.se/foretag/produkter/betala/plusgirot.html">Plusgiro number</a></li> <li><code>SOLDO</code> — Soldo entity identifier</li> <li><code>WALLET_ADYEN_BALANCE_PLATFORM</code> — Adyen balance platform wallet identifier</li> <li><code>WALLET_AIRWALLEX</code> — Airwallex wallet identifier</li> <li><code>WALLET_CURRENCYCLOUD</code> — Currencycloud wallet identifier</li> <li><code>WALLET_FLASH_PAYMENTS</code> — Flash Payments wallet identifier</li> <li><code>WALLET_FREEMARKET</code> — Freemarket wallet identifier</li> <li><code>WALLET_HYPERWALLET</code> — Hyperwallet wallet identifier</li> <li><code>WALLET_INPAY</code> — Inpay account identifier</li> <li><code>WALLET_LEAD</code> — Lead wallet identifier</li> <li><code>WALLET_MERCURY</code> — Mercury wallet identifier</li> <li><code>WALLET_MONEYCORP</code> — Moneycorp wallet identifier</li> <li><code>WALLET_PAYHAWK</code> — Payhawk wallet identifier</li> <li><code>WALLET_REVOLUT</code> — Revolut wallet identifier</li> <li><code>WALLET_SKRILL</code> — Skrill wallet identifier</li> <li><code>WALLET_STRIPE</code> — Stripe wallet identifier</li> <li><code>WALLET_SWISSQUOTE</code> — Swissquote wallet identifier</li> </ul> For further information please refer to <a href="https://docs.atlar.com/v2.0/docs/payment-details#account-identifiers">Account Identifiers</a>
    - `market` string, required — Two-letter ISO 3166-1 alpha2 country code.
    - `number` string, required — The unformatted identifier itself. For type `NUMBER` the structure of the account number is country-specific.
    - `invalid` boolean — Will be `true` if the account identifier is invalid according to Atlar account identifier validation rules.
  - `routing` RoutingIdentifier[], required
    - `type` 'BIC' | 'AT_BLZ' | 'AU_BSB' | 'BR_BRANCH' | 'BR_COMPE' | 'BR_ISP' | 'CA_CPA' | 'CH_BCC' | 'CH_SIC' | 'CL_SBIF' | 'CN_APS' | 'DE_BLZ' | 'ES_NCC' | 'GB_DSC' | 'GR_BIC' | 'HK_NCC' | 'IE_NCC' | 'IL_NCC' | 'IN_FSC' | 'IT_NCC' | 'JP_ZGN' | 'KR_BOK' | 'KR_KFTC' | 'MX_ABM' | 'MY_NCC' | 'NZ_NCC' | 'PL_KNR' | 'PT_NCC' | 'RU_CBC' | 'SE_SBA' | 'SG_IBG' | 'TH_CBC' | 'TW_NCC' | 'US_ABA' | 'US_PID' | 'VN_CITAD' | 'ZA_NCC', required — A routing identifier of type `BIC` must be provided to support cross-border/SWIFT payments.
    - `number` string, required — The form of the routing number depends on `type`. E.g. for `BIC` the value should be an 8 or 11 character BIC/SWIFT code. For `GB_DSC` (UK domestic routing) the value should be a six digit sort code.
    - `invalid` boolean — Will be `true` if the routing identifier is invalid according to Atlar validation rules.
    - `constraints` RoutingConstraints — Constraints on a `RoutingIdentifier`.
      - `accountNumberType` 'IBAN' | 'NUMBER' | 'ADYEN' | 'AU_BPAY_BILLER_CODE' | 'DK_FIK' | 'INVESTMENT_NUMBER' | 'NATIONAL_ID_NUMBER' | 'PAYPAL' | 'PROPRIETARY' | 'SE_BANKGIRO' | 'SE_PLUSGIRO' | 'SOLDO' | 'WALLET_ADYEN_BALANCE_PLATFORM' | 'WALLET_AIRWALLEX' | 'WALLET_CURRENCYCLOUD' | 'WALLET_FLASH_PAYMENTS' | 'WALLET_FREEMARKET' | 'WALLET_HYPERWALLET' | 'WALLET_INPAY' | 'WALLET_LEAD' | 'WALLET_MERCURY' | 'WALLET_MONEYCORP' | 'WALLET_PAYHAWK' | 'WALLET_REVOLUT' | 'WALLET_SKRILL' | 'WALLET_STRIPE' | 'WALLET_SWISSQUOTE' — Account Identifier type. Choose among: <ul> <li><code>IBAN</code> — IBAN</li> <li><code>NUMBER</code> — Account number</li> <li><code>ADYEN</code> — Adyen identifier</li> <li><code>AU_BPAY_BILLER_CODE</code> — Australian BPAY Biller Code</li> <li><code>DK_FIK</code> — FIK creditor number</li> <li><code>INVESTMENT_NUMBER</code> — Investment number</li> <li><code>NATIONAL_ID_NUMBER</code> — National Identification Number</li> <li><code>PAYPAL</code> — PayPal wallet identifier</li> <li><code>PROPRIETARY</code> — Proprietary identifier</li> <li><code>SE_BANKGIRO</code> — <a href="https://www.bankgirot.se/en/">Bankgiro number</a></li> <li><code>SE_PLUSGIRO</code> — <a href="https://www.nordea.se/foretag/produkter/betala/plusgirot.html">Plusgiro number</a></li> <li><code>SOLDO</code> — Soldo entity identifier</li> <li><code>WALLET_ADYEN_BALANCE_PLATFORM</code> — Adyen balance platform wallet identifier</li> <li><code>WALLET_AIRWALLEX</code> — Airwallex wallet identifier</li> <li><code>WALLET_CURRENCYCLOUD</code> — Currencycloud wallet identifier</li> <li><code>WALLET_FLASH_PAYMENTS</code> — Flash Payments wallet identifier</li> <li><code>WALLET_FREEMARKET</code> — Freemarket wallet identifier</li> <li><code>WALLET_HYPERWALLET</code> — Hyperwallet wallet identifier</li> <li><code>WALLET_INPAY</code> — Inpay account identifier</li> <li><code>WALLET_LEAD</code> — Lead wallet identifier</li> <li><code>WALLET_MERCURY</code> — Mercury wallet identifier</li> <li><code>WALLET_MONEYCORP</code> — Moneycorp wallet identifier</li> <li><code>WALLET_PAYHAWK</code> — Payhawk wallet identifier</li> <li><code>WALLET_REVOLUT</code> — Revolut wallet identifier</li> <li><code>WALLET_SKRILL</code> — Skrill wallet identifier</li> <li><code>WALLET_STRIPE</code> — Stripe wallet identifier</li> <li><code>WALLET_SWISSQUOTE</code> — Swissquote wallet identifier</li> </ul> For further information please refer to <a href="https://docs.atlar.com/v2.0/docs/payment-details#account-identifiers">Account Identifiers</a>
      - `scheme` string
  - `type` 'WALLET' | 'SAVINGS' | 'CHECKING' | 'INVESTMENT'
  - `status` 'OPEN' | 'CLOSED', required — Operational status of the account with the holding financial institution.
  - `fictive` boolean, required — Indicates whether the account is a fictive/test account. This will be `true` for accounts associated with the Atlar _Testbank_.
  - `externalId` string — External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix `external:`.
  - `metadata` Metadata, nullable — Metadata is a `string-string` key-value container that can be used to store information known at the time of resource creation. This can be retrieved later on, for instance when a payment or expected transaction is reconciled with the booked transaction on the bank statement. Metadata can have at most 20 entries. Keys may have a maximum length of 64 chars and values a maximum length of 512 chars. By default, this field is optional. It is possible to make it required in the Atlar Dashboard by visiting the [Metadata keys page](https://app.atlar.com/metadata-keys). Requirement rules can be specified per API resource. Both the Dashboard and the API will then enforce these rules and give validation errors when the required fields are not set.
  - `paymentOptions` PaymentOptions
    - `instruments` Instrument[]
      - union — The payment instrument used to initiate the payment. For example Citi has a proprietary payment instrument called WorldLink, which can be used to initiate payments.
        - object
          - `type` 'US_ACH' | 'CITI_WORLDLINK', required — The type of the payment instrument.
          - `citiWorldlinkId` string, required — The WorldLink ID assigned to the account to initiate payments.
        - object
          - `type` 'US_ACH' | 'CITI_WORLDLINK', required — The type of the payment instrument.
          - `usAchCompanyId` string, required — The US ACH Company ID assigned to the account to initiate US ACH payments.
          - `usAchCompanyName` string — Optional US ACH Company Name override. When set, it is used as the debtor name (Dbtr/Nm) on outgoing US ACH payments from this account instead of the account holder's legal name. Only used for US ACH payments.
          - `usAchImmediateOrigin` string — Optional US ACH Immediate Origin. When set, it populates the Immediate Origin field of the NACHA file header instead of the US ACH Company ID. Some banks assign an Immediate Origin that is distinct from the Company ID. Only used for US ACH payments.
    - `initiatorId` string
    - `disabled` boolean — When true, initiating credit transfers from this account is blocked.
  - `version` integer, required — Resource version. Starts at value `1` when the resource is created and increases by one for each successive update.
  - `etag` string, required — [ETag](https://en.wikipedia.org/wiki/HTTP_ETag) based on the resource version. This can be passed along in `If-Match` HTTP header when updating a resource to perform a conditional update.
  - `created` string, date-time, required — Time at which the resource was created.
  - `updated` string, date-time, required — Time at which the resource was last updated.
  - `closed` string, date-time — Time at which the account was closed. Only present if account `status` is `CLOSED`.
  - `provisionState` 'UNPROVISIONED' | 'IGNORED' | 'PROVISIONED', required

## Other responses

- `404` — Resource not found.

---

[API](https://skmtc.net/atlar/apis/atlar-api-v2.md) · [All operations](https://skmtc.net/atlar/apis/atlar-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlar/atlar-api-v2/versions/9c5e194ccf5d/schema)