--- updatedAt: 2026-09-16T12:23:30.000Z agentTools: projectIndex: https://docs.datanomik.com/llms.txt --- # Update Link Credentials Update link information. Usually used when the password of the institution access is change # 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}": { "put": { "summary": "Update Link Credentials", "description": "Update link information. Usually used when the password of the institution access is change", "operationId": "v1itemsid-1", "parameters": [ { "name": "id", "in": "path", "description": "Link identifer", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "institution", "country", "access_type" ], "properties": { "description": { "type": "string", "description": "Link description" }, "metadata": { "type": "object", "description": "Update metadata, password and other fields but not username", "properties": { "type": { "type": "string", "description": "Required for some institutions. Please check institutions endpoint" }, "username": { "type": "string" }, "password": { "type": "string" } } }, "institution": { "type": "string", "description": "Institution name (To see an example please check Institutions endpoint)" }, "country": { "type": "string", "description": "Country ISO Alpha-2", "enum": [ "AR", "BR", "BO", "CO", "CH", "PY", "PE", "UY" ] }, "access_type": { "type": "string", "description": "Type of account you want to access, it could be PERSONAL or BUSINESS", "enum": [ "PERSONAL", "BUSINESS" ] } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\":\"8a9c6df8-f262-478b-9027-476fbcee6bee\",\n \"description\":\"Bussiness Account \",\n \"institution\":\"BANK\",\n \"access_type\":\"BUSINESS\",\n \"refresh_rate\":\"360\",\n \"accessed_at\":\"2022-01-28T23:27:05.266034\",\n \"created_at\":\"2022-01-28T23:27:08.605015\",\n \"updated_at\":\"2022-01-28T23:27:08.605067\",\n \"source\": \"API\",\n \"recurrent\": false,\n \"live\": false\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "8a9c6df8-f262-478b-9027-476fbcee6bee" }, "description": { "type": "string", "example": "Bussiness Account " }, "institution": { "type": "string", "example": "BANK" }, "access_type": { "type": "string", "example": "BUSINESS" }, "refresh_rate": { "type": "string", "example": "360" }, "accessed_at": { "type": "string", "example": "2022-01-28T23:27:05.266034" }, "created_at": { "type": "string", "example": "2022-01-28T23:27:08.605015" }, "updated_at": { "type": "string", "example": "2022-01-28T23:27:08.605067" }, "source": { "type": "string", "example": "API" }, "recurrent": { "type": "boolean", "example": false, "default": true }, "live": { "type": "boolean", "example": false, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"code\": 402,\n \"type\": \"BEAN_VALIDATION_ERROR\",\n \"message\": \"Invalid arguments for specific request. Please check details to satisfy validations\",\n \"details\": [\n \"username: must not be null\",\n \"password: must not be null\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 402, "default": 0 }, "type": { "type": "string", "example": "BEAN_VALIDATION_ERROR" }, "message": { "type": "string", "example": "Invalid arguments for specific request. Please check details to satisfy validations" }, "details": { "type": "array", "items": { "type": "string", "example": "username: must not be null" } } } } } } }, "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" } } } } } }, "412": { "description": "Precondition Failed. The current state of the link/institution does not allow the operation.", "content": { "application/json": { "examples": { "INSTITUTION_NOT_ACTIVE": { "value": "{\n \"code\": 702,\n \"type\": \"INSTITUTION_NOT_ACTIVE\",\n \"message\": \"The institution is not enable, it is not possible to create a link for it.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" }, "TOKEN_REQUIRED_FOR_ACTION": { "value": "{\n \"code\": 707,\n \"type\": \"TOKEN_REQUIRED_FOR_ACTION\",\n \"message\": \"Token required to update this institution's credentials.\",\n \"traceId\": \"0af7651916cd43dd8448eb211c80319c\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 702 }, "type": { "type": "string", "example": "INSTITUTION_NOT_ACTIVE" }, "message": { "type": "string", "example": "The institution is not enable, it is not possible to create a link for it." }, "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 } ```