---
id: service-read-data-sharing-ui
title: "Read data sharing UI"
description: "This endpoint is used to render the data sharing UI during a data exchange as defined by a (data source) organisation in the consent building block."
sidebar_label: "Read data sharing UI"
hide_title: true
hide_table_of_contents: true
api: eJzlV81uGzcQfpUBL7WBteS46UUIgjpxGqgJksA/6MEw4NFytMuYS25IrmxF2FufpI/WJymGu6s/S7Jj91CgPtiyOD8fZzjfzMyEJJ86VQZljRiI81x5ICNLq0wA5aHyJCFYcGQkOQg5gcSA4HN0ymRwMQRZxU/YHNBdmqPJCNCDpLEyJGE0BYS9Rs9WLqV9sC5DozyyX1AmGk6t8WQCjCqlJZscaZve9EQibEkuig6lGAhPbqJSOiWUJxjwrIFyoUQiSnRYUCDnxeBytna54QmMrWtgYuaICjJBJELx4beK3FQkwmBBYiBY6LiTGUqRCEffKuVIikFwFSXCpzkVKAYzEaYlq/jAMERdJ+uOj9OUvIdgb8hECFiFnExQabzUFggYtc5ZacX9GLX/Qf9fhnBD07lr69rIb/Ncqg80fabTNtqcWGWkmihZod7icCGwFuofd/sJCwI7jn5Drpw8KNGF6cqD24Iiin9h6c8uYzvPy/rF6cd5BLYh+cmDtpkFVWBGj4H10WZ2yMIXTj8zUqcklaM0QAd0rbB3VMa85Dob62h+vESaZ/m9IYS3Vm6LRtoc/asXf1RNLMtsu/aDWK5Y2pdMdJ7Pjw4P+c8qvs83IhE5oYw0NqvrRLzcJDdCCcqUVYA57W1QfMGKqTWByW4wE1iWuiWe/lfPhmZLgBd3uRTknHVtKuLnkyX3V0l3OTv6SinzaOmYp4NqrrbQXsRBmUBZREl3WJSaxODl4WG9wfy92C2piDcbLl7zT7JegqZN23eS90LzSxPT/2lohiaQM6iBuyk5iG7WYlQnwlNaORWmsZ0eN31hcHnFRfWG0JHjwo3f8K0x474ruCtDyxEcjYJCbrlzZxSDgawi+m0f7zOjHLS8IxLRANrUwE+osC1ekYjKaTEQeQilH/T7kgp7gKXqqcyhCT1l+5Mjcb/4zwJmzG9bzPjmeIOlq0UwzvhNNKnsQjLPybx3RhJporlgkRWaE+s56fr06njQg/OcYIK6mje26xU719C4gaLyAUYEpaOxuiMJtyrkcN1ghGvYMzZQ048cKh3DUGJK+wlQL+utmR1Aq/hqaivHETm4oenr656ok5Xkz8Qo/vebdQUGMRC//3F+/27LM1CJ3nfwGkstZh4FV1vBPIKxEDmGjTMxLzJOHdO8UGZsu4rGNFY0Fag4vb4qS+vCr/OULs0e7xdfrb6FhfC96pkrwd7ff/61z5MywtktSeXz9TnYSJiQU+M2ndA+eyidnShJrgfDwHO2B096fODthBypzICS/AjCNGn1caQJUkfxa9Q+4ZlbZSqghlvUmkJ05q1WEkorIVCaG6ttpsgnQAZHupnUDd2CpglpflDMPJGecKS0CtNoBKtgCwwsntqi1ApNSk3C4vUcZZWO9/GcM4RxpTW/XKlCxFmgMeR4eNcqJeMj13VVUGKaExz1Du/F/Pb2tofxuGdd1m91ff/j8O27T2fvDlinTkRQQa8kD7h2pE0rnte76mIaafJ1dHj0svdz7wXrltaHAs0SHt4kNkw/cpV0543iv7oltfUQ6C70S43K8G1jeGct5152uxPfbpl1rxKRWx9YYjYboefxsq7562YMilysPGd2MeZsjc/eadsq92HbzrUR6w0z6YbVK3KfGIiGzh8N4+G1aweK1e3rqQh2LF67fHc95Ilut61eO1yubWBPdLyU+EfuYTsgbVrHnojrKavYY5GtbWTPj9wj9rIHqmfLevbUR7xpNduBoN3QnujtweVsV91s39EWaK74HxebaTPJdkMac1xjh4mjDEta9xaDenmqff+Oxx1sZ6HFHHgTa7j9wNa7I7Nc2+sjYQOBf3PgNqq8Yl75QNPXc/HmZKvCfIjqil3UV3Vd/wOVovCp
sidebar_class_name: "get api-method"
info_path: docs/consent-management-individual-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Read data sharing UI</h1>

<MethodEndpoint method={"get"} path={"/service/data-sharing"}></MethodEndpoint>



This endpoint is used to render the data sharing UI during a data exchange as defined by a (data source) organisation in the consent building block.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"ID for data agreement","in":"query","name":"dataAgreementId","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Access token for authentication","in":"query","name":"accessToken","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"API key for authorisation","in":"query","name":"apiKey","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"ID for the individual","in":"query","name":"individualId","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Name of the third-party organisation","in":"query","name":"thirdPartyOrgName","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"URL for the third-party organisation's logo image","in":"query","name":"thirdPartyOrgLogoImageUrl","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Redirect URL for data sharing UI","in":"query","name":"dataSharingUiRedirectUrl","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Authorization Code","in":"query","name":"code","required":false,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"description":"Redirect URL for authorisation","in":"query","name":"authorisationRedirectUrl","required":false,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Ok

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>