--- updatedAt: 2026-09-16T12:23:30.000Z agentTools: projectIndex: https://docs.datanomik.com/llms.txt --- # Account Position List all accounts of yours links # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "openbanking-api", "version": "1.0" }, "servers": [ { "url": "https://api.datanomik.com" } ], "components": { "securitySchemes": { "sec0": { "type": "http", "scheme": "basic" } } }, "security": [ { "sec0": [] } ], "paths": { "/v1/accounts/position": { "get": { "summary": "Account Position", "description": "List all accounts of yours links", "operationId": "account-position", "parameters": [ { "name": "linkId", "in": "query", "description": "Identifier of the link from which you want to get detailed information about.", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Country code in ISO Alpha-2 format", "schema": { "type": "string", "enum": [ "AR", "BR", "BO", "CO", "CH", "PY", "PE", "UY" ] } }, { "name": "institution", "in": "query", "description": "Institution name", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "description": "Identifier of the account from which you want to get detailed information about.", "schema": { "type": "string" } }, { "name": "accountNumber", "in": "query", "description": "Account number in the institution", "schema": { "type": "string" } }, { "name": "accountType", "in": "query", "description": "Account type, such as SAVING, CHECKING, etc", "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Currency code in ISO 4217 format", "schema": { "type": "string" } }, { "name": "availableBalanceGte", "in": "query", "description": "Available balance greater than or equals", "schema": { "type": "number", "format": "double" } }, { "name": "availableBalanceLte", "in": "query", "description": "Available balance less than or equals", "schema": { "type": "number", "format": "double" } }, { "name": "currentBalanceGte", "in": "query", "description": "Current balance greater than or equals", "schema": { "type": "number", "format": "double" } }, { "name": "currentBalanceLte", "in": "query", "description": "Current balance less than or equals", "schema": { "type": "number", "format": "double" } }, { "name": "updateAtFrom", "in": "query", "description": "Date format: YYYY-MM-dd HH:mm:ss", "schema": { "type": "string" } }, { "name": "updateAtTo", "in": "query", "description": "Date format: YYYY-MM-dd HH:mm:ss", "schema": { "type": "string" } }, { "name": "institutionId", "in": "query", "description": "Institution Id", "schema": { "type": "string" } }, { "name": "ownerId", "in": "query", "description": "Owner Id", "schema": { "type": "string" } }, { "name": "workspaceView", "in": "query", "description": "View name or id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"content\": [\n {\n \"id\": \"5042b7b2-1914-44f0-8c59-18cfcf37eeea\",\n \"account_number\": \"2022612\",\n \"type\": \"Conta Corrente\",\n \"category\": \"CHECKING\",\n \"balance\": {\n \"current_balance\": 834662.03,\n \"available_balance\": 834662.03,\n \"diff_percentage\": 0,\n \"diff_indicator\": {\n \"type\": \"REGULAR\"\n },\n \"start_of_day_balance\": 834662.03,\n \"last_day_balance\": 171134.17,\n \"currency\": \"BRL\",\n \"balance_history\": {},\n \"investment_current_balance\": 47160.73,\n \"investment_available_balance\": 46760.70,\n \"forecast_balance\": 171134.17,\n \"cash_position\": 217894.87\n },\n \"refreshed_at\": \"2024-06-13T10:00:43.202554Z\",\n \"up_to_date\": true,\n \"updated_at\": \"2024-06-13T10:00:25.97143Z\",\n \"owner\": {\n \"id\": \"16d0c3cc-059e-4765-915b-775611c2d29d\",\n \"document\": \"91.626.076/8512-79\",\n \"document_type\": \"CNPJ\",\n \"display_name\": \"FERREIRA PEIXOTO LTDA.\",\n \"email\": \"isabelly15@example.org\",\n \"phone_number\": \"21 2269 7817\"\n },\n \"metadata\": {},\n \"status\": \"ACTIVE\",\n \"country\": \"BR\",\n \"institution_logo\": \"https://resources.datanomik.com/institutions/br/XP.svg\",\n \"institution\": \"XP\",\n \"institution_description\": \"XP\",\n \"institution_id\": \"d2d8f39f-6daa-4623-92fd-797ef7d881da\",\n \"investments\": [\n {\n \"id\": \"b402b168-84e5-4f3e-bf81-82c5e060966c\",\n \"instrument_type\": \"DEPOSIT\",\n \"description\": \"CDB BANCO\",\n \"net_balance\": 46760.70,\n \"main_balance\": 46760.70,\n \"gross_balance\": 47160.73,\n \"updated_at\": \"2024-06-13T10:00:43.698017Z\"\n }\n ],\n \"link_id\": \"dd265cf9-5851-4422-850c-0e03783a0a85\",\n \"external_id\": \"24e28561-b196-4c52-935c-7a22dc7c35ba\",\n \"tags\": [],\n \"favourite\": false,\n \"ownership\": 100.0,\n \"account_sync_status\": \"PROCESSED\",\n \"trx_sync_status\": \"PROCESSED\",\n \"investment_sync_status\": \"PROCESSED\",\n \"payment_sync_status\": \"PROCESSED\",\n \"account_group\": {}\n }\n ],\n \"first\": true,\n \"last\": true,\n \"page_number\": 0,\n \"page_size\": 50,\n \"total_elements\": 1,\n \"total_pages\": 1\n}" } }, "schema": { "type": "object", "properties": { "content": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "5042b7b2-1914-44f0-8c59-18cfcf37eeea" }, "account_number": { "type": "string", "example": "2022612" }, "type": { "type": "string", "example": "Conta Corrente" }, "category": { "type": "string", "example": "CHECKING" }, "balance": { "type": "object", "properties": { "current_balance": { "type": "number", "example": 834662.03, "default": 0 }, "available_balance": { "type": "number", "example": 834662.03, "default": 0 }, "diff_percentage": { "type": "integer", "example": 0, "default": 0 }, "diff_indicator": { "type": "object", "properties": { "type": { "type": "string", "example": "REGULAR" } } }, "start_of_day_balance": { "type": "number", "example": 834662.03, "default": 0 }, "last_day_balance": { "type": "number", "example": 171134.17, "default": 0 }, "currency": { "type": "string", "example": "BRL" }, "balance_history": { "type": "object", "properties": {} }, "investment_current_balance": { "type": "number", "example": 47160.73, "default": 0 }, "investment_available_balance": { "type": "number", "example": 46760.7, "default": 0 }, "forecast_balance": { "type": "number", "example": 171134.17, "default": 0 }, "cash_position": { "type": "number", "example": 217894.87, "default": 0 } } }, "refreshed_at": { "type": "string", "example": "2024-06-13T10:00:43.202554Z" }, "up_to_date": { "type": "boolean", "example": true, "default": true }, "updated_at": { "type": "string", "example": "2024-06-13T10:00:25.97143Z" }, "owner": { "type": "object", "properties": { "id": { "type": "string", "example": "16d0c3cc-059e-4765-915b-775611c2d29d" }, "document": { "type": "string", "example": "91.626.076/8512-79" }, "document_type": { "type": "string", "example": "CNPJ" }, "display_name": { "type": "string", "example": "FERREIRA PEIXOTO LTDA." }, "email": { "type": "string", "example": "isabelly15@example.org" }, "phone_number": { "type": "string", "example": "21 2269 7817" } } }, "metadata": { "type": "object", "properties": {} }, "status": { "type": "string", "example": "ACTIVE" }, "country": { "type": "string", "example": "BR" }, "institution_logo": { "type": "string", "example": "https://resources.datanomik.com/institutions/br/XP.svg" }, "institution": { "type": "string", "example": "XP" }, "institution_description": { "type": "string", "example": "XP" }, "institution_id": { "type": "string", "example": "d2d8f39f-6daa-4623-92fd-797ef7d881da" }, "investments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "b402b168-84e5-4f3e-bf81-82c5e060966c" }, "instrument_type": { "type": "string", "example": "DEPOSIT" }, "description": { "type": "string", "example": "CDB BANCO" }, "net_balance": { "type": "number", "example": 46760.7, "default": 0 }, "main_balance": { "type": "number", "example": 46760.7, "default": 0 }, "gross_balance": { "type": "number", "example": 47160.73, "default": 0 }, "updated_at": { "type": "string", "example": "2024-06-13T10:00:43.698017Z" } } } }, "link_id": { "type": "string", "example": "dd265cf9-5851-4422-850c-0e03783a0a85" }, "external_id": { "type": "string", "example": "24e28561-b196-4c52-935c-7a22dc7c35ba" }, "tags": { "type": "array", "items": { "type": "object", "properties": {} } }, "favourite": { "type": "boolean", "example": false, "default": true }, "ownership": { "type": "integer", "example": 100, "default": 0 }, "account_sync_status": { "type": "string", "example": "PROCESSED" }, "trx_sync_status": { "type": "string", "example": "PROCESSED" }, "investment_sync_status": { "type": "string", "example": "PROCESSED" }, "payment_sync_status": { "type": "string", "example": "PROCESSED" }, "account_group": { "type": "object", "properties": {} } } } }, "first": { "type": "boolean", "example": true, "default": true }, "last": { "type": "boolean", "example": true, "default": true }, "page_number": { "type": "integer", "example": 0, "default": 0 }, "page_size": { "type": "integer", "example": 50, "default": 0 }, "total_elements": { "type": "integer", "example": 1, "default": 0 }, "total_pages": { "type": "integer", "example": 1, "default": 0 } } } } } }, "400": { "description": "Bad Request. Invalid or missing parameters/body, or a business rule that rejects the request.", "content": { "application/json": { "examples": { "BEAN_VALIDATION_ERROR": { "value": "{\n \"code\": 402,\n \"type\": \"BEAN_VALIDATION_ERROR\",\n \"message\": \"Invalid arguments for specific request. Please check details to satisfy validations\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\",\n \"details\": [\n \"linkId: must not be blank\"\n ]\n}" }, "TYPE_MISMATCH": { "value": "{\n \"code\": 454,\n \"type\": \"TYPE_MISMATCH\",\n \"message\": \"Type mismatch for parameter\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 402 }, "type": { "type": "string", "example": "BEAN_VALIDATION_ERROR" }, "message": { "type": "string", "example": "Invalid arguments for specific request. Please check details to satisfy validations" }, "traceId": { "type": "string", "example": "0af7651916cd43dd8448eb211c80319c" }, "details": { "type": "array", "items": { "type": "string" }, "example": [ "linkId: must not be blank" ] } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"code\": 401,\n \"type\": \"UNAUTHORIZED\",\n \"message\": \"Invalid credentials\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 401, "default": 0 }, "type": { "type": "string", "example": "UNAUTHORIZED" }, "message": { "type": "string", "example": "Invalid credentials" } } } } } }, "403": { "description": "Forbidden. Source IP not whitelisted, credentials without the required scope, or trial period expired.", "content": { "application/json": { "examples": { "IP_NOT_ALLOWED": { "value": "{\n \"code\": 632,\n \"type\": \"IP_NOT_ALLOWED\",\n \"message\": \"Source ip address not allowed.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" }, "FORBIDDEN": { "value": "{\n \"code\": 403,\n \"type\": \"FORBIDDEN\",\n \"message\": \"Forbidden\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 632 }, "type": { "type": "string", "example": "IP_NOT_ALLOWED" }, "message": { "type": "string", "example": "Source ip address not allowed." }, "traceId": { "type": "string", "example": "0af7651916cd43dd8448eb211c80319c" } } } } } }, "500": { "description": "Internal Server Error. Unexpected error; report the `traceId` to support.", "content": { "application/json": { "examples": { "INTERNAL_ERROR": { "value": "{\n \"code\": 500,\n \"type\": \"INTERNAL_ERROR\",\n \"message\": \"Unexpected error. Please contact support with the traceId.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 500 }, "type": { "type": "string", "example": "INTERNAL_ERROR" }, "message": { "type": "string", "example": "Unexpected error. Please contact support with the traceId." }, "traceId": { "type": "string", "example": "0af7651916cd43dd8448eb211c80319c" } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```