--- updatedAt: 2026-09-16T12:23:30.000Z agentTools: projectIndex: https://docs.datanomik.com/llms.txt --- # Detail Institution Get institutions detail # 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/institutions/{id}": { "get": { "summary": "Detail Institution", "description": "Get institutions detail", "operationId": "v1institutionsid", "parameters": [ { "name": "id", "in": "path", "description": "Institution identifier (UUID)", "schema": { "type": "string" }, "required": true }, { "name": "showRelations", "in": "query", "description": "Describes which fields are necessary for register a link with an specific institution", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"f15d81eb-7f7c-4536-b57a-b65b03ebd78c\",\n \"description\": \"Bradesco\",\n \"country\": \"BR\",\n \"name\": \"BRADESCO\",\n \"type\": \"BANK\",\n \"logo\": \"https://resources.datanomik.com/institutions/br/Bradesco.svg\",\n \"widget_enabled\": false,\n \"authentication_types\": [\n {\n \"id\": \"6b85f038-eb44-4aac-8cff-6da5c573b245\",\n \"description\": \"Default\",\n \"code\": \"DEFAULT\",\n \"steps\": [\n {\n \"id\": \"4812a711-9cc5-427c-a083-8db41327061d\",\n \"step_number\": 0,\n \"field_sets\": [\n {\n \"id\": \"a83a1562-5de5-48dd-a311-811ad4708a1c\",\n \"label_key\": \"credentials_key\",\n \"number\": 1,\n \"action_key\": \"submit_key\",\n \"fields\": [\n {\n \"id\": \"862e4e12-c35d-4bc8-9056-b11799716f73\",\n \"required\": true,\n \"label_key\": \"lbl_user\",\n \"options\": [],\n \"otp\": false,\n \"name\": \"username\",\n \"type\": \"text\",\n \"position\": 1,\n \"placeholder\": \"User\"\n },\n {\n \"id\": \"5fb7b16e-00ad-48fc-a787-a48618697dee\",\n \"required\": true,\n \"label_key\": \"lbl_password\",\n \"options\": [],\n \"otp\": false,\n \"name\": \"password\",\n \"type\": \"password\",\n \"position\": 2,\n \"placeholder\": \"Password\"\n },\n {\n \"id\": \"ed78151e-d85e-4aed-a820-810dcef33f2b\",\n \"required\": false,\n \"label_key\": \"lbl_company_name\",\n \"options\": [],\n \"otp\": false,\n \"name\": \"company_name\",\n \"type\": \"text\",\n \"position\": 3,\n \"placeholder\": \"Company Name\"\n }\n ]\n }\n ]\n }\n ],\n \"default\": true\n }\n ],\n \"images\": [\n {\n \"id\": \"24fb9eb9-9fd0-40d7-9180-b0989b2ca634\",\n \"image_url\": \"https://resources.datanomik.com/contextual_help/br/bradesco/Bradesco.png\",\n \"position\": 1\n }\n ],\n \"support_balance_history\": false\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "f15d81eb-7f7c-4536-b57a-b65b03ebd78c" }, "description": { "type": "string", "example": "Bradesco" }, "country": { "type": "string", "example": "BR" }, "name": { "type": "string", "example": "BRADESCO" }, "type": { "type": "string", "example": "BANK" }, "logo": { "type": "string", "example": "https://resources.datanomik.com/institutions/br/Bradesco.svg" }, "widget_enabled": { "type": "boolean", "example": false, "default": true }, "authentication_types": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "6b85f038-eb44-4aac-8cff-6da5c573b245" }, "description": { "type": "string", "example": "Default" }, "code": { "type": "string", "example": "DEFAULT" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "4812a711-9cc5-427c-a083-8db41327061d" }, "step_number": { "type": "integer", "example": 0, "default": 0 }, "field_sets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "a83a1562-5de5-48dd-a311-811ad4708a1c" }, "label_key": { "type": "string", "example": "credentials_key" }, "number": { "type": "integer", "example": 1, "default": 0 }, "action_key": { "type": "string", "example": "submit_key" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "862e4e12-c35d-4bc8-9056-b11799716f73" }, "required": { "type": "boolean", "example": true, "default": true }, "label_key": { "type": "string", "example": "lbl_user" }, "options": { "type": "array", "items": { "type": "object", "properties": {} } }, "otp": { "type": "boolean", "example": false, "default": true }, "name": { "type": "string", "example": "username" }, "type": { "type": "string", "example": "text" }, "position": { "type": "integer", "example": 1, "default": 0 }, "placeholder": { "type": "string", "example": "User" } } } } } } } } } }, "default": { "type": "boolean", "example": true, "default": true } } } }, "images": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "24fb9eb9-9fd0-40d7-9180-b0989b2ca634" }, "image_url": { "type": "string", "example": "https://resources.datanomik.com/contextual_help/br/bradesco/Bradesco.png" }, "position": { "type": "integer", "example": 1, "default": 0 } } } }, "support_balance_history": { "type": "boolean", "example": false, "default": true } } } } } }, "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": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"code\": 610,\n \"type\": \"INSTITUTION_NOT_FOUND\",\n \"message\": \"Institution resource not found.\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 610, "default": 0 }, "type": { "type": "string", "example": "INSTITUTION_NOT_FOUND" }, "message": { "type": "string", "example": "Institution resource not found." } } } } } }, "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 } ```