--- updatedAt: 2026-09-16T12:23:30.000Z agentTools: projectIndex: https://docs.datanomik.com/llms.txt --- # Sync Assets Consolidated information of yours links with owners, users, accounts and balances # 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/links/sync/assets/{linkId}": { "post": { "summary": "Sync Assets", "description": "Consolidated information of yours links with owners, users, accounts and balances", "operationId": "list-assets-copy", "parameters": [ { "name": "linkId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "Link identifier (UUID)" } ], "responses": { "204": { "description": "204", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"content\": [\n {\n \"id\": \"c40d94ca-184b-4520-9fd1-5cc418b8f612\",\n \"description\": \"Test Link\",\n \"institution\": \"BRADESCO\",\n \"institution_logo\": \"https://resources.datanomik.com/institutions/uy/Bradesco.svg\",\n \"access_type\": \"BUSINESS\",\n \"country\": \"BR\",\n \"refresh_rate\": \"180\",\n \"accessed_at\": \"2022-02-15T19:04:57.980228\",\n \"created_at\": \"2022-02-15T19:05:00.064292\",\n \"updated_at\": \"2022-02-15T19:05:00.064308\",\n \"source\": \"API\",\n \"recurrent\": false,\n \"live\": false,\n \"status\": \"ACTIVE\",\n \"accounts\": [\n {\n \"id\": \"118a011c-85cf-49cd-b818-c9fd1063f0ce\",\n \"description\": \"Account Description\",\n \"account_number\": \"45555223\",\n \t\"type\": \"CA\", \n \"category\t\": \"SAVING\",\n \"balance\": {\n \"current_balance\": 10.0,\n \"available_balance\": 10.0,\n \"currency\": \"USD\"\n },\n \"refreshed_at\": \"2022-05-13T13:01:11.952Z\",\n \"created_at\": \"2022-05-13T12:57:45.564897Z\",\n \"updated_at\": \"2022-05-13T13:01:12.168382Z\",\n \"owners\": [\n {\n \"id\": \"a2d9a143-ab1e-4cba-874f-6d0fc2d7dd5d\",\n \"document\": \"123456789\",\n \"document_type\": \"CPF\",\n \"first_name\": \"PEDRO\",\n \"last_name\": \"OLIVEIRA\",\n \"second_last_name\": \"NUNEZ\",\n \"display_name\": \"PEDRO OLIVEIRA NUNEZ\",\n \"email\": \"demo@demo.com\"\n }\n ],\n \t\"blocked\": false\n }\n ],\n \"users\": [\n {\n \"id\": \"f5d70f6d-cbfe-495e-933e-42fb05ab648b\",\n \"username\": \"12345678\",\n \"metadata\": {\n \"document\": \"12345678\",\n \"document_type\": \"CI\",\n \"first_name\": \"PEDRO\",\n \"last_name\": \"OLIVEIRA\",\n \"second_last_name\": \"NUNEZ\",\n \"display_name\": \"PEDRO OLIVEIRA NUNEZ\",\n \"email\": \"pedrooliveira@gmail.com\",\n \"address\": \"ADDRESS 1234, 11300, MONTEVIDEO, URUGUAY\",\n \"phone_number\": \"099999999\"\n }\n }\n ]\n }\n ],\n \"first\": true,\n \"last\": true,\n \"page_number\": 0,\n \"page_size\": 20,\n \"total_elements\": 1,\n \"total_pages\": 1\n}" } } } } }, "400": { "description": "Bad Request. Invalid or missing parameters/body, or a business rule that rejects the request.", "content": { "application/json": { "examples": { "ASSETS_ON_DEMAND_REFRESH_UNSUPPORTED": { "value": "{\n \"code\": 773,\n \"type\": \"ASSETS_ON_DEMAND_REFRESH_UNSUPPORTED\",\n \"message\": \"Asset refresh operation not supported for this kind of link.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" }, "LINKS_PLAN_INACTIVE": { "value": "{\n \"code\": 631,\n \"type\": \"LINKS_PLAN_INACTIVE\",\n \"message\": \"There is no active plan in order to be able to establish a new link.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 773 }, "type": { "type": "string", "example": "ASSETS_ON_DEMAND_REFRESH_UNSUPPORTED" }, "message": { "type": "string", "example": "Asset refresh operation not supported for this kind of link." }, "traceId": { "type": "string", "example": "0af7651916cd43dd8448eb211c80319c" } } } } } }, "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" } } } } } }, "404": { "description": "Not Found. The referenced resource does not exist or does not belong to your workspace.", "content": { "application/json": { "examples": { "LINK_NOT_FOUND": { "value": "{\n \"code\": 600,\n \"type\": \"LINK_NOT_FOUND\",\n \"message\": \"Link resource not found.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 600 }, "type": { "type": "string", "example": "LINK_NOT_FOUND" }, "message": { "type": "string", "example": "Link resource not found." }, "traceId": { "type": "string", "example": "0af7651916cd43dd8448eb211c80319c" } } } } } }, "409": { "description": "Conflict. The resource already exists or an equivalent operation is already in progress.", "content": { "application/json": { "examples": { "ASSETS_ON_DEMAND_REFRESH_EXISTS": { "value": "{\n \"code\": 730,\n \"type\": \"ASSETS_ON_DEMAND_REFRESH_EXISTS\",\n \"message\": \"This process is running and cannot be run again until it is finished.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" }, "LINK_EXECUTION_ALREADY_PROCESSING": { "value": "{\n \"code\": 609,\n \"type\": \"LINK_EXECUTION_ALREADY_PROCESSING\",\n \"message\": \"Link synchronization already in progress.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 730 }, "type": { "type": "string", "example": "ASSETS_ON_DEMAND_REFRESH_EXISTS" }, "message": { "type": "string", "example": "This process is running and cannot be run again until it is finished." }, "traceId": { "type": "string", "example": "0af7651916cd43dd8448eb211c80319c" } } } } } }, "412": { "description": "Precondition Failed. The current state of the link/institution does not allow the operation.", "content": { "application/json": { "examples": { "INSTITUTION_OFFLINE": { "value": "{\n \"code\": 880,\n \"type\": \"INSTITUTION_OFFLINE\",\n \"message\": \"The institution is currently offline. Manual link refresh is not allowed until it goes back online.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 880 }, "type": { "type": "string", "example": "INSTITUTION_OFFLINE" }, "message": { "type": "string", "example": "The institution is currently offline. Manual link refresh is not allowed until it goes back online." }, "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 } ```