# Get all linked accounts

Retrieves all the Linked Accounts belonging to the logged-in Identity.

Endpoint: GET /linked_accounts
Version: 3.63.5
Security: auth_token, api-key

## Query parameters:

  - `offset` (integer)
    The offset value for paging, indicating the initial item number to be returned from the data set satisfying the given criteria. Leave out to fetch the first page of results.

  - `limit` (integer)
    The limit of the results for paging, starting at the offset. Limit is always capped at 100.

  - `profileId` (string)
    Filter by the managed account/card profile. Leave out to fetch all managed accounts/card.

  - `friendlyName` (string)
    Filter by the managed account/card friendly name. Leave out to fetch all managed accounts/card.

The exact name must be provided, as wildcards are not supported.

  - `state` (array)
    Enum: "ACTIVE", "BLOCKED", "DESTROYED"

  - `currency` (string)
    Filter by the managed account/card currency.

Currencies are expressed as an ISO 4217 code. Leave out to fetch all managed accounts/card.

  - `createdFrom` (integer)
    Filter for managed accounts/cards created after createdFrom timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all managed accounts/cards.

  - `createdTo` (integer)
    Filter for managed accounts/cards created before createdTo timestamp. Timestamp is expressed in Epoch timestamp using millisecond precision. Leave out to fetch all managed accounts/cards.

  - `tag` (string)
    Filter by the managed account/card tag. The exact tag must be provided, as wildcards are not supported. Leave out to fetch all managed accounts/card.

## Response 200 fields (application/json):

  - `accounts` (array)
    The filtered managed accounts list.

  - `accounts.id` (string, required)
    The unique identifier of the linked account.

  - `accounts.profileId` (string, required)
    The profile Id which a specific identity, instrument or transaction type is linked to.

Profiles contain configuration and determine behavioral aspects of the newly created transaction, for example, fees that may apply.

You can have one or more profiles linked to your application, and these can be used to drive different behaviors according to your product's needs.

Profile Ids can be found in the Multi Portal, in the API Credentials page.

  - `accounts.tag` (string)
    The tag field is a custom field that can be used to search and filter.

  - `accounts.friendlyName` (string)
    A user-friendly label assigned to the Linked Account to help end-users easily identify it within the application. This name can be updated at any time using the PATCH endpoint

  - `accounts.name` (string, required)
    The full name or corporate name of the account holder as registered with the external bank or payment service provider. This is the name under which the account is officially held.

  - `accounts.type` (string)
    An account can be of two types, Personal or Business:
  - PERSONAL means that the account held at the external bank or PSP is registered under the ownership of a natural person or consumer identity;
  - BUSINESS means that the account held at the external bank or PSP is registered under the ownership of a corporate entity.
    Enum: "BUSINESS", "PERSONAL"

  - `accounts.currency` (string)
    The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.

  - `accounts.country` (string, required)
    The country of the bank or institution at which the account is held.

  - `accounts.accountReference` (any)
    The IBAN or Account Number and Sort Code of the account held at the external bank or payment service provider.

  - `accounts.state` (string, required)
    The state of the linked account:
  - PENDING_VERIFICATION: The Linked Account is pending the completion of the required verification steps.
  - ACTIVE: The Linked Account is verified and active, ready to be used for self-to-self wire transfers.
  - BLOCKED: The Linked Account is temporarily blocked, preventing any use of this external account in self-to-self wire transfers. A Linked Account can be unblocked by calling the Multi API endpoint POST /linked_accounts/{id}/unblock.
  - REMOVED: The Linked Account has been removed from the platform and can no longer be used for self-to-self wire transfers unless a new verification is completed in future.
  - REJECTED: The Linked Account failed the verification process and cannot be used for self-to-self wire transfers unless a new verification is completed in future.
A Linked Account can transition through these different overall states, starting at the PENDING_VERIFICATION state until all verification steps are followed through.
    Enum: "PENDING_VERIFICATION", "BLOCKED", "ACTIVE", "REJECTED", "REMOVED"

  - `accounts.creationTimestamp` (integer)
    The timestamp when the linked account was created, expressed in Epoch timestamp using millisecond precision.

  - `accounts.owner` (object)

  - `accounts.owner.type` (string, required)

  - `accounts.owner.id` (string, required)

  - `count` (integer)
    The total number of records (excluding the paging limit).

  - `responseCount` (integer)
    The total number of records returned in this response (always capped at 100).

## Response 400 fields (application/json):

  - `message` (string)
    When present helps to identify and fix the problem.

  - `syntaxErrors` (object)
    Is returned as part of an HTTP error response whenever a syntax error is detected. A list of the fields together with their syntax error will be provided.

  - `syntaxErrors.invalidFields` (array)

  - `syntaxErrors.invalidFields.params` (array)

  - `syntaxErrors.invalidFields.fieldName` (string)

  - `syntaxErrors.invalidFields.error` (string)
    Enum: "REQUIRED", "HAS_TEXT", "REQUIRES", "SIZE", "RANGE", "IN", "NOT_IN", "REGEX", "EXACTLY", "AT_LEAST", "AT_MOST", "ALL_OR_NONE"

## Response 403 fields (application/json):

  - `errorCode` (string)
    Enum: "STEP_UP_REQUIRED", "ACCESS_TOKEN_REQUIRED"

## Response default fields (application/json):

  - `code` (string)

  - `message` (string)


## Response 401 fields

## Response 429 fields

## Response 500 fields

## Response 503 fields