---
updatedAt: 2026-09-16T12:46:35.000Z
agentTools:
  projectIndex: https://docs.datanomik.com/llms.txt
---

# Detail Link

Retrieve a link

# 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/{linkId}": {
      "get": {
        "summary": "Detail Link",
        "description": "Retrieve a link",
        "operationId": "v1itemsid",
        "parameters": [
          {
            "name": "linkId",
            "in": "path",
            "description": "Link identifier (UUID)",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"id\": \"b0f8ccb9-aad8-4fe9-a531-cd6ddd04cae2\",\n    \"description\": \"PERSONAL ACCOUNT <PEDRO DE OLIVERA>\",\n    \"institution\": \"SANTANDER\",\n    \"institution_type\": \"BANK\",\n    \"institution_description\": \"Santander\",\n    \"institution_logo\": \"https://resources.datanomik.com/institutions/uy/Santander.svg\",\n    \"access_type\": \"PERSONAL\",\n    \"country\": \"UY\",\n    \"refresh_rate\": \"360\",\n    \"accessed_at\": \"2022-07-06T17:10:33.005627079Z\",\n    \"created_at\": \"2022-01-28T23:27:08.605015\",\n    \"updated_at\": \"2022-01-28T23:27:08.605067\",\n    \"mode\": \"AUTOMATIC\",\n    \"source\": \"API\",\n    \"recurrent\": false,\n    \"live\": false,\n    \"status\": \"ACTIVE\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "example": "b0f8ccb9-aad8-4fe9-a531-cd6ddd04cae2"
                    },
                    "description": {
                      "type": "string",
                      "example": "PERSONAL ACCOUNT <PEDRO DE OLIVERA>"
                    },
                    "institution": {
                      "type": "string",
                      "example": "SANTANDER"
                    },
                    "institution_type": {
                      "type": "string",
                      "example": "BANK"
                    },
                    "institution_description": {
                      "type": "string",
                      "example": "Santander"
                    },
                    "institution_logo": {
                      "type": "string",
                      "example": "https://resources.datanomik.com/institutions/uy/Santander.svg"
                    },
                    "access_type": {
                      "type": "string",
                      "example": "PERSONAL"
                    },
                    "country": {
                      "type": "string",
                      "example": "UY"
                    },
                    "refresh_rate": {
                      "type": "string",
                      "example": "360"
                    },
                    "accessed_at": {
                      "type": "string",
                      "example": "2022-07-06T17:10:33.005627079Z"
                    },
                    "created_at": {
                      "type": "string",
                      "example": "2022-01-28T23:27:08.605015"
                    },
                    "updated_at": {
                      "type": "string",
                      "example": "2022-01-28T23:27:08.605067"
                    },
                    "mode": {
                      "type": "string",
                      "example": "AUTOMATIC"
                    },
                    "source": {
                      "type": "string",
                      "example": "API"
                    },
                    "recurrent": {
                      "type": "boolean",
                      "example": false
                    },
                    "live": {
                      "type": "boolean",
                      "example": false
                    },
                    "status": {
                      "type": "string",
                      "example": "ACTIVE"
                    }
                  }
                }
              }
            }
          },
          "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"
                    }
                  }
                }
              }
            }
          },
          "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"
                    }
                  }
                }
              }
            }
          },
          "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
}
```