---
updatedAt: 2026-04-22T15:20:23.000Z
agentTools:
  projectIndex: https://docs.data.one/llms.txt
---

# Get Specified Open Banking Connected User Account

Given a `userId` and `accountId` this endpoint will fetch the specified account's details.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "info": {
    "version": "v1",
    "title": "Retrieving Data",
    "description": "Endpoints relating to Open Banking data, i.e. accounts and transactions, for a specific user, plus risk score insights."
  },
  "paths": {
    "/v1/users/{userId}/accounts/{accountId}": {
      "get": {
        "tags": [
          "Accounts"
        ],
        "operationId": "getConnectedUserAccount",
        "summary": "Get Specified Open Banking Connected User Account",
        "description": "Given a `userId` and `accountId` this endpoint will fetch the specified account's details.",
        "security": [
          {
            "ApiKeyAuth": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/UserId"
          },
          {
            "$ref": "#/components/parameters/AccountId"
          }
        ],
        "responses": {
          "200": {
            "description": "The Open Banking connected account successfully received.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccountResponse"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/ApiKeyUnauthorizedError"
          },
          "404": {
            "description": "User or account is invalid or does not exist."
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api-sandbox.data.one",
      "description": "Hostname for sandbox API"
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key",
        "description": "Secret API key used for authentication."
      }
    },
    "schemas": {
      "AccountVerification": {
        "type": "object",
        "properties": {
          "nameMatchScore": {
            "type": "number",
            "description": "A value between 0 and 1 indicating the strength of the match between the the given user name and the name on the account. A value of 1 represents a perfect match."
          },
          "nameMatchField": {
            "type": "string",
            "enum": [
              "PartiesFullLegalName",
              "PartiesName"
            ],
            "description": "The user name is matched against the full legal name or in its absence to the name field in the parties data. This field indicates which field the user name was matched against in calculating the score."
          },
          "nameMatchValue": {
            "type": "string",
            "description": "The value of the field indicated by the nameMatchField."
          },
          "userName": {
            "type": "string",
            "description": "The user name given by the partner."
          }
        }
      },
      "CreditLine": {
        "type": "object",
        "properties": {
          "available": {
            "type": "number",
            "format": "currency",
            "description": "The amount of credit available to a user on their agreed credit line, overdraft in case of a current account or credit limit in case of a credit card. Note: not all banks return this."
          },
          "credit": {
            "type": "number",
            "format": "currency",
            "description": "The amount of credit a user has agreed with this banking provider. This could be an overdraft in the case of a current account or the credit limit in the case of a credit card. Note: not all banks return this."
          }
        },
        "example": {
          "available": 100,
          "credit": 1000
        }
      },
      "PartyResponse": {
        "type": "object",
        "properties": {
          "partyType": {
            "type": "string",
            "enum": [
              "Delegate",
              "Joint",
              "Sole"
            ],
            "description": "The type of party attached to the account."
          },
          "name": {
            "type": "string",
            "description": "Name by which a party is known and which is usually used to identify that party."
          },
          "fullLegalName": {
            "type": "string",
            "description": "The full legal name of the party."
          },
          "address": {
            "type": "string",
            "description": "At time of writing, no bank returns this data."
          }
        },
        "example": {
          "partyType": "Sole",
          "name": "Mary Smith",
          "fullLegalName": "Mrs Mary Margaret Smith",
          "address": null
        }
      },
      "AccountResponse": {
        "type": "object",
        "properties": {
          "accountId": {
            "type": "string",
            "format": "uuid",
            "description": "The unique identifier for the account."
          },
          "providerId": {
            "type": "string",
            "format": "uuid",
            "description": "The GUID of the Financial Institution this account belongs to."
          },
          "providerName": {
            "type": "string",
            "description": "The Name of the Financial Institution this account belongs to."
          },
          "userId": {
            "type": "string",
            "format": "uuid",
            "description": "The GUID of the user this account belongs to."
          },
          "accountType": {
            "$ref": "#/components/schemas/AccountType"
          },
          "accountNumber": {
            "type": "string",
            "description": "The account number for the account, or the PAN number if it is a credit card.\n\nDepending on the Financial Institution this could be masked, especially if it it s a PAN. I.e.\n\nXXXX-XXXX-XXXX-X123\n\nbut also if it is a current account Id:\nXXXX1234"
          },
          "accountName": {
            "type": "string",
            "description": "The name this Financial Institution has stored for the account.\n\nNote: the value defaults to 'British Pound Account' if it's missing from the account details returned by the bank."
          },
          "sortCode": {
            "type": "string",
            "description": "The sort code for the account if the account is a current account."
          },
          "currency": {
            "type": "string",
            "description": "ISO 4217 currency code representing the base currency of the account."
          },
          "lastRefreshStatus": {
            "type": "string",
            "enum": [
              "SUCCESS",
              "TOKEN_REFRESH_FAILURE",
              "ACCOUNT_REFRESH_ERROR",
              "TRANSACTION_FETCH_ERROR",
              "MISSING_ACCOUNT",
              "UNKNOWN"
            ],
            "description": "An string representing the outcome of the last account refresh attempt."
          },
          "tokenCreatedDate": {
            "type": "string",
            "format": "date-time",
            "description": "The DateTime when the OAuth token linked to the account was created."
          },
          "tokenRefreshDate": {
            "type": "string",
            "format": "date-time",
            "description": "The DateTime when the OAuth token linked to the account was last refreshed."
          },
          "tokenExpiryDate": {
            "type": "string",
            "format": "date-time",
            "description": "The DateTime when the OAuth token linked to the account will expire."
          },
          "openingDate": {
            "type": "string",
            "format": "date-time",
            "description": "The DateTime when the account was opened at the Financial Institution.\n\nThis is likely to be sparsely populated."
          },
          "lastTransactionRefresh": {
            "type": "string",
            "format": "date-time",
            "description": "The DateTime when the transactions were last refreshed.",
            "deprecated": true
          },
          "lastTransactionRefreshDate": {
            "type": "string",
            "format": "date-time",
            "description": "The DateTime when the transactions were last refreshed."
          },
          "balance": {
            "type": "number",
            "description": "The balance in the account at the time of the last refresh as specified in `lastAccountRefreshDate` field."
          },
          "lastAccountRefreshDate": {
            "type": "string",
            "format": "date-time",
            "description": "The DateTime when the account was last refreshed."
          },
          "parties": {
            "type": "array",
            "description": "An array of details of the account owner(s)/holder(s) for the account.\n\nNote: only some banks return this data, null will be returned if the bank does not support returning parties data.\n\nNote: At time of writing, no banks return an address",
            "items": {
              "$ref": "#/components/schemas/PartyResponse"
            }
          },
          "creditLine": {
            "$ref": "#/components/schemas/CreditLine"
          },
          "accountVerification": {
            "$ref": "#/components/schemas/AccountVerification"
          },
          "accountOwnerType": {
            "type": "string",
            "enum": [
              "PERSONAL",
              "BUSINESS",
              "UNKNOWN"
            ],
            "description": "The type of account ownership. Indicates whether the account is a personal account, business account, or unknown."
          },
          "correlationId": {
            "type": "string",
            "description": "The `correlationId` is a field which allows the client to place a custom identifier for the account."
          }
        },
        "required": [
          "accountId",
          "providerId",
          "providerName",
          "userId",
          "accountName",
          "lastRefreshStatus",
          "balance",
          "currency",
          "tokenCreatedDate",
          "tokenRefreshDate",
          "creditLine",
          "accountOwnerType"
        ]
      },
      "AccountType": {
        "type": "string",
        "enum": [
          "EMoney",
          "Mortgage",
          "Joint Account",
          "Savings Goal",
          "Investment Account",
          "Credit Card",
          "Crypto Account",
          "Pension",
          "Current Account",
          "Loan",
          "Charge Card",
          "Savings Account",
          "PrePaid Card"
        ],
        "description": "The type of account returned.\n\nCan be null value if an account type hasn't been seen before."
      }
    },
    "responses": {
      "ApiKeyUnauthorizedError": {
        "description": "API key authentication unsuccessful."
      }
    },
    "parameters": {
      "UserId": {
        "in": "path",
        "name": "userId",
        "description": "The User ID",
        "schema": {
          "type": "string",
          "format": "uuid"
        },
        "required": true,
        "example": "2590eaff-94dc-43f4-be30-bdab6c2cec8b"
      },
      "AccountId": {
        "in": "path",
        "name": "accountId",
        "description": "The Account ID",
        "schema": {
          "type": "string",
          "format": "uuid"
        },
        "required": true,
        "example": "845c7468-123a-4139-a098-e3378c7598b2"
      }
    }
  }
}
```