--- updatedAt: 2026-09-16T12:23:30.000Z agentTools: projectIndex: https://docs.datanomik.com/llms.txt --- # Retrieve Link Retrieve a link information on demand # 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/{id}": { "post": { "summary": "Retrieve Link", "description": "Retrieve a link information on demand", "operationId": "retrieve-link", "parameters": [ { "name": "id", "in": "path", "description": "Link identifier (UUID)", "schema": { "type": "string" }, "required": true }, { "name": "dateFrom", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "202": { "description": "202", "content": { "application/json": { "examples": { "Requested": { "value": "{\n \"request_id\": \"e55810a1-f8f2-4478-ba26-f55449383fb3\",\n \"status\": \"REQUESTED\"\n}" } }, "schema": { "type": "object", "properties": { "request_id": { "type": "string", "example": "e55810a1-f8f2-4478-ba26-f55449383fb3" }, "status": { "type": "string", "example": "REQUESTED" } } } } } }, "400": { "description": "Bad Request. Invalid or missing parameters/body, or a business rule that rejects the request.", "content": { "application/json": { "examples": { "EXCEEDED_MAX_RECOVERY_PERIOD": { "value": "{\n \"code\": 615,\n \"type\": \"EXCEEDED_MAX_RECOVERY_PERIOD\",\n \"message\": \"Range of dates sent is major than available for this institution (max 3 months)\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" }, "INVALID_RANGE_OF_DATES": { "value": "{\n \"code\": 616,\n \"type\": \"INVALID_RANGE_OF_DATES\",\n \"message\": \"Range of dates exceed one month\",\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": 615 }, "type": { "type": "string", "example": "EXCEEDED_MAX_RECOVERY_PERIOD" }, "message": { "type": "string", "example": "Range of dates sent is major than available for this institution (max 3 months)" }, "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_INVALID_STATUS": { "value": "{\n \"code\": 1074,\n \"type\": \"LINK_NOT_FOUND_INVALID_STATUS\",\n \"message\": \"Link not found or its current status does not allow a refresh request to be processed.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 1074 }, "type": { "type": "string", "example": "LINK_NOT_FOUND_INVALID_STATUS" }, "message": { "type": "string", "example": "Link not found or its current status does not allow a refresh request to be processed." }, "traceId": { "type": "string", "example": "0af7651916cd43dd8448eb211c80319c" } } } } } }, "409": { "description": "Conflict. The resource already exists or an equivalent operation is already in progress.", "content": { "application/json": { "examples": { "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": 609 }, "type": { "type": "string", "example": "LINK_EXECUTION_ALREADY_PROCESSING" }, "message": { "type": "string", "example": "Link synchronization already in progress." }, "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": { "LINK_RECENTLY_REFRESHED": { "value": "{\n \"code\": 633,\n \"type\": \"LINK_RECENTLY_REFRESHED\",\n \"message\": \"Link recently refreshed.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" }, "LINK_MODE_NOT_ALLOWED": { "value": "{\n \"code\": 810,\n \"type\": \"LINK_MODE_NOT_ALLOWED\",\n \"message\": \"Link mode not allowed.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" }, "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": 633 }, "type": { "type": "string", "example": "LINK_RECENTLY_REFRESHED" }, "message": { "type": "string", "example": "Link recently refreshed." }, "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 } ```