--- updatedAt: 2025-10-24T06:29:04.000Z agentTools: projectIndex: https://developer.integrated.finance/llms.txt --- # List Accounts # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Account API", "description": "Operations for Accounts", "version": "1" }, "servers": [ { "url": "https://sandbox-api.integrated.finance/v1/{instanceId}", "description": "Sandbox", "variables": {} }, { "url": "https://api.integrated.finance/v1/{instanceId}", "description": "Production", "variables": {} } ], "paths": { "/accounts": { "get": { "tags": [ "Accounts" ], "summary": "List Accounts", "operationId": "accounts.list", "parameters": [ { "name": "metadata.page.number", "in": "query", "description": "0-indexed page number", "schema": { "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "metadata.page.size", "in": "query", "description": "page size", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } }, { "name": "metadata.sort", "in": "query", "description": "default direction is ascending", "schema": { "type": "string" }, "example": "data.client.fullName,desc" }, { "name": "data.account.clientId", "in": "query", "schema": { "type": "string" } }, { "name": "data.account.currency", "in": "query", "schema": { "type": "string" } }, { "name": "data.account.status", "in": "query", "schema": { "type": "string", "enum": [ "pending", "active", "inactive", "suspended", "closed", "declined" ] } }, { "name": "data.account.alias", "in": "query", "schema": { "type": "string" } }, { "name": "data.account.iban", "in": "query", "schema": { "type": "string" } }, { "name": "data.account.accountNumber", "in": "query", "schema": { "type": "string" } }, { "name": "data.account.routingCodeKey", "in": "query", "schema": { "$ref": "#/components/schemas/RoutingCodeType" } }, { "name": "data.account.routingCodeValue", "in": "query", "schema": { "type": "string" } }, { "name": "data.account.accountHolderName", "in": "query", "schema": { "type": "string" } }, { "name": "data.account.ledgerNumber", "in": "query", "schema": { "type": "string" } }, { "name": "data.account.serviceProvider", "in": "query", "schema": { "type": "string" } }, { "name": "data.account.availableBalanceFrom", "in": "query", "schema": { "type": "string" } }, { "name": "data.account.availableBalanceTo", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Account list returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountListResponse" }, "example": { "workflow": "{}", "data": { "accounts": [ { "id": "045f4568-3a75-4bcf-97f3-54cfeeb45137", "clientId": "afcbd6f0-d34b-4512-bd24-c229815f53e5", "status": "active", "country": "GB", "currency": "GBP", "alias": "TCC GBP Test Account", "routingCodes": {}, "iban": null, "accountNumber": null, "ledgerNumber": "41858872", "availableBalance": 0, "receivableBalance": 0, "accountHolderName": "I.F Technology Ltd", "accountHolderIdentityType": "corporate", "serviceProvider": "currencycloud" } ] }, "connect": "{}", "metadata": { "page": { "size": 20, "number": 0, "totalElements": 1, "totalPages": 1 } } } } } } } } } }, "components": { "schemas": { "Account": { "required": [ "accountHolderIdentityType", "clientId", "country", "currency", "id", "ledgerNumber", "mainAccountId", "routingCodes", "serviceProvider", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "id of account", "format": "uuid", "readOnly": true }, "clientId": { "type": "string", "description": "id of client", "format": "uuid" }, "status": { "$ref": "#/components/schemas/AccountStatus" }, "country": { "maxLength": 2, "minLength": 2, "type": "string", "description": "ISO 3166-1 alpha-2 country code", "readOnly": true }, "currency": { "maxLength": 3, "minLength": 3, "type": "string", "description": "ISO 4217 currency code" }, "alias": { "maxLength": 30, "type": "string", "description": "alias of account, refer to Accounts section in Guides for details" }, "routingCodes": { "$ref": "#/components/schemas/RoutingCodeMap" }, "iban": { "maxLength": 31, "minLength": 15, "pattern": "^[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[0-9]{4}([a-zA-Z0-9]?){3,19}$|^[A-Z]{2}\\d{5}[0-9A-Z]{13}$", "type": "string", "description": "iban assigned to account", "nullable": true, "readOnly": true }, "accountNumber": { "maxLength": 20, "minLength": 8, "pattern": "^[0-9]{8,20}$", "type": "string", "description": "account number assigned to account", "nullable": true, "readOnly": true }, "accountHolderName": { "type": "string" }, "ledgerNumber": { "maxLength": 8, "minLength": 8, "pattern": "^[0-9]{8,8}$", "type": "string", "description": "unique ledger number of account generated internally", "readOnly": true }, "availableBalance": { "type": "number", "description": "available balance of account", "format": "double", "readOnly": true }, "receivableBalance": { "type": "number", "description": "receivable balance of account", "format": "double", "readOnly": true }, "payableBalance": { "type": "number", "description": "payable balance of account", "format": "double", "readOnly": true }, "accountHolderIdentityType": { "$ref": "#/components/schemas/LegalEntityType" }, "connection": { "$ref": "#/components/schemas/AccountConnectionResource" }, "serviceProvider": { "type": "string", "description": "service provider which this account connected to", "readOnly": true }, "mainAccountId": { "type": "string", "description": "the main account id which the given account is linked to", "format": "uuid", "readOnly": true }, "attributes": { "$ref": "#/components/schemas/AttributeMap" } } }, "AccountConnectionResource": { "type": "object", "properties": { "id": { "type": "string" }, "serviceProvider": { "type": "string" }, "reference": { "type": "string" }, "state": { "$ref": "#/components/schemas/ServiceProviderConnectionState" }, "status": { "$ref": "#/components/schemas/ThirdPartyAccountStatus" }, "method": { "$ref": "#/components/schemas/ConnectMethod" }, "error": { "$ref": "#/components/schemas/ConnectionErrorResource" } }, "description": "Account Connection Resource Object", "readOnly": true }, "AccountStatus": { "type": "string", "description": "status of account", "readOnly": true, "enum": [ "pending", "active", "inactive", "suspended", "closed", "declined" ] }, "AttributeMap": { "type": "object", "description": "attributes of account" }, "ConnectMethod": { "type": "string", "enum": [ "built-in", "plug-in" ] }, "ConnectionErrorResource": { "type": "object", "properties": { "category": { "$ref": "#/components/schemas/ErrorCategory" }, "origin": { "$ref": "#/components/schemas/ErrorOrigin" }, "code": { "type": "string" }, "message": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ErrorCategory": { "type": "string", "enum": [ "functional", "technical" ] }, "ErrorOrigin": { "type": "string", "enum": [ "customer", "platform", "provider" ] }, "LegalEntityType": { "type": "string", "description": "type of account holder client's identity", "readOnly": true, "enum": [ "corporate", "individual" ] }, "RoutingCodeMap": { "type": "object", "description": "routing codes of account as map, refer to Accounts section in Guides for details", "readOnly": true }, "ServiceProviderConnectionState": { "type": "string", "enum": [ "pending", "creation-in-progress", "update-in-progress", "dependency-completed", "completed-up-to-date", "completed-outdated", "dependency-failed", "creation-failed" ] }, "ThirdPartyAccountStatus": { "type": "string", "enum": [ "active", "inactive", "closed" ] }, "AccountListConnectContainer": { "type": "object" }, "AccountListDataContainer": { "type": "object", "properties": { "account": { "$ref": "#/components/schemas/AccountResourceQueryInput" }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } } }, "AccountListMetadataContainer": { "required": [ "page" ], "type": "object", "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } } }, "AccountListResponse": { "required": [ "connect", "data", "metadata", "workflow" ], "type": "object", "properties": { "workflow": { "$ref": "#/components/schemas/AccountListWorkflowContainer" }, "data": { "$ref": "#/components/schemas/AccountListDataContainer" }, "connect": { "$ref": "#/components/schemas/AccountListConnectContainer" }, "metadata": { "$ref": "#/components/schemas/AccountListMetadataContainer" } } }, "AccountListWorkflowContainer": { "type": "object" }, "AccountResourceQueryInput": { "type": "object", "properties": { "clientId": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "status": { "type": "array", "items": { "$ref": "#/components/schemas/AccountStatus" } }, "currency": { "type": "array", "items": { "type": "string" } }, "alias": { "type": "string" }, "routingCodeKey": { "$ref": "#/components/schemas/RoutingCodeType" }, "routingCodeValue": { "type": "string" }, "iban": { "type": "array", "items": { "type": "string" } }, "accountNumber": { "type": "array", "items": { "type": "string" } }, "ledgerNumber": { "type": "array", "items": { "type": "string" } }, "availableBalanceFrom": { "type": "number" }, "availableBalanceTo": { "type": "number" }, "serviceProvider": { "type": "array", "items": { "type": "string" } }, "accountHolderName": { "type": "string" }, "accountType": { "type": "array", "items": { "$ref": "#/components/schemas/AccountType" } }, "mainAccountId": { "type": "string" }, "attributes": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AccountType": { "type": "string", "enum": [ "main-account", "sub-account", "standalone-account" ] }, "PageMetadata": { "required": [ "number", "size", "totalElements", "totalPages" ], "type": "object", "properties": { "size": { "minimum": 0, "type": "integer", "description": "number of elements in this page", "format": "int32" }, "number": { "minimum": 0, "type": "integer", "description": "index of page starting from 0", "format": "int32" }, "totalElements": { "minimum": 0, "type": "integer", "description": "total number of elements in all of the pages", "format": "int64", "readOnly": true }, "totalPages": { "minimum": 0, "type": "integer", "description": "number of total pages", "format": "int32", "readOnly": true } } }, "RoutingCodeType": { "type": "string", "enum": [ "bic", "sort-code", "aba", "rtn-canada", "clabe", "bsb-code", "ifsc", "cnaps", "bank-code", "branch-code" ] } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```