---
id: list-opted-in-individuals
title: "List Opted-In Individuals"
description: "Lists individuals that have opted-in to the underlying Data Agreement within the specified Data Disclosure Agreement Record."
sidebar_label: "List Opted-In Individuals"
hide_title: true
hide_table_of_contents: true
api: eJzlWM1uGzkSfpUCTzbQasmO48UKg8E4sTPQZpAEcQZ7iA243CypOWaTHZItWWvotk+yj7ZPsiiy1Wr9GPac9jAXu8VmFYtVX1V91U9Cki+cqoOyRozFb8oHD8pINVeyQe0hlBigxDmBrQPJgTIQLISSoDGSnF4qM4NLDAgXM0dUkQmwUKHkfSWBr6lQU0Uy7blUvtDWN456279SYZ3Mb4zIRI0OKwrkvBh/fxIGKxJjITHgRrSTTIITKTKh2PoaQymynSv9btSPhmByCXYKuGdG0iEy4ehHoxxJMQ6uoUz4oqQKxfhJhGXNRvjglJmJ1eqWN/vaGk+e35+ORvxv35N84ufotYmBycapIhOFNYFMYDmsa60KZLnhH56Fn3qH187W5IJKR/Ui07MMncMlOyFQFddR68/T6MB2h73/g4ogMhFU0LywsWbPYdclam0XegmVlaQ9YN94WJSqKKHCJTiakiNTEHhbESjjA/IvZViEHgM5gxr80geq4MjRTPng4kXbxQymjSl4ATVMLjOY2sZI7BaAQnGcw8WWAd05dgqhVD6ZCcqDsYHBeU9QKR/wgUyEIiA0CQQGQ+OiirW2HCaBRZt6DevWXLsw5HhNUqEkgWoPcxEvUJOrVPBQYV1zBgQLeEA9oJFD61gawSsz09S/irMLKNCwFtbgaU4sXzC0TABcA93nIhOPA2PDQJkBZ8M9ehLjKWpP2S5G5D5oMzG1rsIgxkJkgh6xqiMMzs/enp3gKZ3T396e/300Gp2cvS3k+fkeKL7FhO9nktm5SC5WrDkFffInbGg8uV/an3lhq72zv3Y4Yy8bG0pyW0gZ7qAoQVR50OqB9BK+TCbbxn2Lhr3WQKpQ7afJ1Rrfk0tgPV2pczlcQFKZwwcO/hqwN0nVjQDr4EbsgP1G5PAeDcO38SQ5jTQGcvCjIafIRwcrSSaosPzi7FxJcn/G0YeCjfcnpweCrTwUttGSjUEDHz5mcN8EmFoHxi5gQSBtTLfYGbBLAzuFtYVQtyb6HCaX797FkhG3V9YRtOW2RfdqtcpeU6yuHoNDv1Wtv6cmkXVhqktrSNzupkVqJfu+2r76J6zawkK9NI6ex+qws7cVvHeEgV3CsOYYPtCy0BYfuBSA5/uz7jsl7wA93EW1dxGe0f4XD7jibTC5ZJF01RdFvsRtvL/x5Scb1LTtN9/sA5mX5S9prmL2cUU96BwZdzyXVoe1LWs6+nx9fEBhJsg0FYcWjXRWxQZvvbhdZYKR9hzsd8+ZKkM+Kk9SoOQh82NH35FllsBoR9Ov5ovSQol+jwpt85+I5j0w9xHbb+O3q7j9bHTCV3o1L+irI+ese29lzAJ+vuxd5nbflO3E2EhvXKpMoBm5fvk4G41WB9QfCMOm4rxDLmN1E6Djdeyc1WqfpGETSuvUv4iDXRLKSAGfkmvO/sKu+UreNq6gWG5jy9hz0NtEQP+iDpqYNdEkNycH8ZgdH60y4alonArLSIsvavWR+PGWcz/gjMcN8eyI4tkTFYXSSjEWM4qO4GFjLIbzN0M+WBU0ZGI2kJ38oONvw8Qah08vDDKrodqaEtKN0ii0W9wq215YZKJxWoxFGULtx8OhpMoOsFa5mjk0IVdWcHfdYfkBZ9yxn9Hh0+tdNbcbP14znBIK1t7cDCRpoR3LUiBEtp7mLtpUj/DcK9sXXybcM4ELAjOJhOIcmIHOUTdde77b0nMH6RioGh+YttSOpuqRZBoB7pKNcAdHxobUg4NDpaMPaizoOAPKZ/mO2jG0gj8tbePYHYMHWv58F8nYO0JHjvfz3e/jrw9r6vWPf37bv1tRkPdtI63R+7V5SVNrM7OGLSOg82DMYfZhOkx0+clxEwxzZaZ2XQywiMWgJRbCN3VtXfhlE88uJOrXzdI2EPoY2rlNJwRH//33f46ZcCNcL0gqXwIjHeixKNHMKHKfObmOeECbMh1JjHNY48mDJz0deDsnR2pmOjqZtfJ4rwkKR3EZtc8AQaqZCtyeUWsKiWhZrSTUVkKgojRW25kinwEZvI8xRzC0AE1z0pG1chHhyob3SjN7ZSXYBFth4O2FrWqtIouPAYvXczRrdLyPj0MvTButGblShWhnhcaQ4+FNq4KMpw0RFRc1FiXBaT7a8/liscgxvs6tmw1bWT/8bfL+6tP11YBlVht6vIkD5460RcM1ZZ1dXEBSvE5Hp2f5m/wkMkHrQ4WmZ0/8YPHM1wq5XbS7RvP//17Uwj/QYxjWGpXhy0VvPrUV+ruYv2lLqSq4yz1bpSNJa78GjV/zyalH4jJRWh/4tKcnns1/d3q14mUe3mKjycQcXYRvKufK87PshvhnfXz0tW3Xx/Dab1kHvbKuzYYLc6ykaUB84NL94ie2FZPvtg6x/UmKC1odevr2iMeq3zl/veKaiG3B3DSLh9gs2ofeZ6ttW3f7RjKB//aGx22RnzgjPtLy5257evOsQFdp0272HBP0/wG37WDJ
sidebar_class_name: "get api-method"
info_path: docs/datamarketplace-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"}>List Opted-In Individuals</h1>

<MethodEndpoint method={"get"} path={"/v3/service/data-disclosure-agreement/record/{dataDisclosureAgreementRecordId}/individuals"}></MethodEndpoint>



Lists individuals that have opted-in to the underlying Data Agreement within the specified Data Disclosure Agreement Record.


## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"dataDisclosureAgreementRecordId","in":"path","description":"Unique ID of a Data Disclosure Record","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

List of Opted-In Individuals

</div><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={"individuals"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"allOf":[{"type":"object","title":"Individual","description":"Shallowly models an Individual which may reference some instance in an external system (registration system, functional ID, foundational ID etc). An Individual instance of this model is not to be mistaken with a unique natural individual. It is up to the system owner to decide if this record permits mapping to a natural individual and/or if a single Individual row can map to several consent agreements.","x-not-in-database":false,"properties":{"id":{"type":"string","format":"","example":"64541a2e6e7569000145cd66","description":"The unique ID of an Individual row."},"externalId":{"type":"string","format":"","example":"user@example.com","description":"Reference to another foundational/functional ID, which is likely PII"},"externalIdType":{"type":"string","format":"","example":"email","description":"External ID type specifier. A string. For instance \"email\" or \"foundational ID\". Can be used in later queries."},"identityProviderId":{"type":"string","format":"","example":"64541a2e6e7569000145ab12","description":"This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements."}}},{"type":"object","title":"IndividualExtras","required":["name","email","phone"],"properties":{"name":{"type":"string","description":"Name of the individual"},"iamId":{"type":"string","description":"Create a user in keycloak and save the `id` as `iamId`"},"email":{"type":"string","description":"Email ID"},"phone":{"type":"string","description":"Phone"},"pushNotificationToken":{"type":"string","description":"Device token of the individual"},"deviceType":{"type":"string","description":"Device type(OS) of the individual","enum":["android","ios"]},"mapperId":{"type":"string","description":"Defines the mapper id of the individual"}}}],"description":"Data for an individual who has opted-in to the Data Agreement"}}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"individuals\": [\n    {\n      \"id\": \"64541a2e6e7569000145cd66\",\n      \"externalId\": \"user@example.com\",\n      \"externalIdType\": \"email\",\n      \"identityProviderId\": \"64541a2e6e7569000145ab12\",\n      \"name\": \"string\",\n      \"iamId\": \"string\",\n      \"email\": \"string\",\n      \"phone\": \"string\",\n      \"pushNotificationToken\": \"string\",\n      \"deviceType\": \"android\",\n      \"mapperId\": \"string\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></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={"404"} value={"404"}><div>

Resource not found

</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>