---
id: config-read-individual-by-mapper-id
title: "Read individual by mapper ID"
description: "Reads the individual of the organisation that has this `mapperId`: the second ID that you gave the individual, for example its user ID in your mobile app."
sidebar_label: "Read individual by mapper ID"
hide_title: true
hide_table_of_contents: true
api: eJztWdty3DYS/ZUuvKxUyxmNLnHsScoV2fKmlMSXip1ytiKViSGaJDIkwADgjGZV87Zfsp+2X7LVAG/DGfmytQ9bW+sHWQLRYHfjdPfp5j0TaBMjKye1YnP2M3JhweUIUgm5kqLmBejUr2iTcSUtp63gcu4g57RXWohLXlVorkU891stJloJuL4K+za6hoyvcHRwBKk2gHe8rAoE6SzUFg1JSUUyBkq9kAUCr6opi5iu0Pi3Xws2Z4lWqcxI4evuxGebl40iLGIVN7xEh8ay+W/3I0PDPnpXY93A3qPenGN6rySBirucRUzxEtmclf1rDP5RS4OCzZ2pMWI2ybHkbH7P3KaivdYZqTK2jVhjKpszXlUTMnZyNpudsu0tHWMrrSxakjybzei/XZXf7WhJiiVaOVSOtvKqKmTivXPyu6X99/ua6MXvmLgdnX9j/ZHsNmKVIS87GfQYPKN3FMXr1PtyfJ6TzpvV3wSLRtpfQoXGagXrXFuEhGxVbh9YBhNthN3FBoektk6XaKZAbgibIOEKKi3pGO1Pal4hFXClXY4G7MY6LMHlRtdZDjHeOTSKF9cinsKPiFUjwwsQ3HESld1xpVSyrMsexApRkOPvJkq7iVQTkllwi2ye8sLinv/EPg6GMHjE09nj08Xp+WN8nJ6fiyT9+smTR2eP97zXOxaur4IPLJoVGYjOgnRTeItKkO5Sed3jXyfPg4+fPZv04tcihhy5QNMCv72JxqdG1w7tNMC19dXHrWjvZnJKYB6r/lcKZL1Wg1gLLn/oikHV5YJu+tqBtFAr+UeNrVlDrMyBt5lmEL1r6fKQhHiJ0NpAb8/IVfHF7Ek8Mu+dN+1zTHzlVduz8T0BZCmVIAuvr3ZgBnIE5nj3sBi0gRhLLouglxSonHSbN0avpPBZ5oBuI3z0eayRhqoRfzh9DyKm0JklF5PzIpApcLWZsu12G31OsL+4c4ZbNkZ/yJUfc+tlgXdwpXHPnld0d3uZObiHl1/mkUJnlBCSRNfKHUj3jSc6x1FgyQQPRRmsc1RjeaqCXO1cof/10zq+oG3AhTBo7RTeE3K5AhwuR01B9Wrwwmoo+RIt8JFdhLBxHWvXKiNXPNmA4DZfaG7E8RQuR+/pKzrvD+WFQS42XeTMgnlVrtXBm9017w1ta6PZy9U2f6WdTJtK9U4vUX3GObXNQQ3kwJFge5UC6boeQEt4+FCA777ndeAXKmurxu4LyJvVWBU7hRdl5TYBGUo7ggp5dwOhAK14UeOOAyOGqi6p9LKIcSWMlsQjpLbsdhv11OKT+l4OeJZOA2NKci0T3E04ZMM4+foaOeRX/5FsW3asaifXbre3lEr6wB8zC6qTHyuGw0q0V27GeXw/WR/KqKwnc4Ms1CQXdn5+eoGPLtLJYsYXk4vZ148nT87O08nZ2VczXCwW4gnnrItzZnxF/a6xb5roknVRwv588ejrWfhH6j4QBIztgnWAjB4RY9649W69mJ0eZouXb65hiRto0kCIGmmhlNYSzLXxiF3xQoov4pND/ojGaPNcC3Kf//1qoMdttFc+dmtEL93DXSqHmb+4DjAXs9n2wPEfLS7POCG1qh10nQBrD/kRN58TXw7vHCRadNnFYFpbXoRkKTRa78Ak5yrDvjgEMb9op/BaFRuwuuykLeTUDEk34gXDaPtga1uhEijiCOIUuasNfhDS8kWBInCGqjaVtvgB76R1NgRaA4jzTwPCg6EzgReFXodmLuFF4etDu5tiXNehStpEV503uoYshLtfKohyLLTYQHx/w+hmb1gEN+wlWsszvGHb2B8e/zp5y5VY6LvXJhuwUu9ZCkzbc/iwb4/BNDlKdfq0Cofkc3/ToyvoMMZPUOY9XRuHquAu1aYELkqpQm9bG4XE6cLxzS3sW9/W2aGCoW5zZddo/GFxC7z40H1yJULLgZSzuh0xHNGqGtCh5snxFwUsV5umdfv3Q/djXPC1v3Z/hr/8vVgi9PWPW1t4khD1SHJMlt1aJSPvDp02UeM7ksFjSLTB6aiNbcxoYMZut7e7BSfkmIvZeb9nzn5RvHa5NvJvKBplvvmFZhAUF+pPLgQqKt87Vmh84tTKfuOpMQuQpTxGf311qGl/pcdU0d9yVyeP4r9wWaCgljNFl+TD7YtNu1OKOXzb1oGn8XHU5vSGGKb+kP/n8P+VHL6NmMWkNtJtfNReVtKbOxzX2DnRDkJ6xBzPaMo1HMDcRqxEl2uiDRn6W6MR1pydrC5OwvDspM15J/2pJwFlJ/ct2raMdCGUHZqjXWGpGxCyiNWG2FDuXGXnJycCSz3hlZzKzHDlplL7HLJ7wFvHM0+5D59hw+PxMbe9f94SogMQWy91oOBhoRnhhXAd8L4m9v1l7SOnKSaUIYg+hkAKXWEg9Q2e4p1zukJW1tbBgpovTOUdikCV46AjxHCktAvc3BkuC++Diid4HAFOs+no2Dk0gt8SzSd3TJa4eRrvFGrpmzddcaLwQUcPcuu4cbZRQK/t8gPJBRE1KNs/vH8HvgQeyZEQbn6Ij0FpKLTK0MBam6WdU0fcEv3TOOr7gKbshWayVktF858lbqbwToPBquAJTXyWuIkgMcgd/aVwPVSpa1ahVqTcZdOTPoUrXGFBCYgMt/AUnocjyA3kIt/38kB0UupaDvCHCCwWmDSk5hDBSKWx7jiimbTf1KjnrVQgsMDm+nQhgm1DykT+AU1Z40Ar1SXvB4iN83M8CwtdEy3QEVgKMiXoBh4iTv6ipKM2jVI7WheWeK8VVVX+CeolQzp8UL0G9D3Nupidx9MbdaPe576XPESkukQYmtSdA4/8UIOnjsqcs8Gz9MADEAXFA09yT0v3LDo02+oR2YK3J14PpGeKBk8zAmAqo0WduI7wtY4hIkjYOmBETJPgy8wglqicpYTfDFZfcsUzv0qLzSjmqgV3qAJrXORaL218PHDqvvafTxtDLB6gjVRgKB2mmtIkkQWeeLLQtrK2ript3Hd9su3ypfy+X9rN0sMEP0qjnRAc/fPv/zj2OQrerlFIm4eRO941tZeMWaHpxzzNJK4bZfohRW3RUvCmE6tXaFBmqpvdRY08eYcSi1/mhY2Ag5CZdDSx4EWBzr/M6kIKqLQAh0muNE3U0EaAii98Qg5JqaB8Q34kUuOZD1/IgkaFPqBqp8swNkp0WRWSqwTD3XnzDGZ1EWZFYeiS1kVBZUVI5/UsuVI0IItYIRNUFvvZKbuseJIjnE1nez5fr9dT7h9PtclOGll78tP18xev3r6YkMy2Z+j9PVDsCJ3UBMm29FF1D/d1Nju7mJ5PT/28TltXcjXQhz63HWao11fjCnrfc9H/7u+KDVkgxkeMSCqy3Tv7vuFMv7HVReDWqSSO2aY4zywGn7yCuixi825mcxuxXFtHZ9zf06eiX0yx3dLyHzUaonS3EVtx4zEbCFYT3d03pQe9evRzw+GP4Uu+Zx60t2VMiuiS5w5hJrUkQtWPoHxb1RApUjY8vkwSrNxAcK/12A7p6Pcv3tHosybXDrna0nO15pfBd8Zdpca0LahAPwcd6q7Itw01eNptD08eFOioYthNLqIR5r8A0HnibA==
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-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 individual by mapper ID</h1>

<MethodEndpoint method={"get"} path={"/v4/config/platform/individual/mapper/{mapperId}"}></MethodEndpoint>



Reads the individual of the organisation that has this `mapperId`: the second ID that you gave the individual, for example its user ID in your mobile app.

## 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={{"description":"Mapper ID of the individual (`mapperId`).","in":"path","name":"mapperId","required":true,"schema":{"type":"string"},"example":"app-user-2001"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

The individual.

</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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>individual</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

A person whose consent the organisation records, for example a customer. The record can point to the person in another system through `externalId`. Keep personal data in it to the minimum that you need.

</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"6af081b138e8f33dcf799628","description":"Individual ID. The server sets it. Send it in the `X-ConsentBB-IndividualId` header of the consent record routes."}}></SchemaItem><SchemaItem collapsible={false} name={"externalId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"customer-1001","description":"Your own ID of the person, for example a customer number. It is unique in the organisation: a second individual with the same external ID gets `409`."}}></SchemaItem><SchemaItem collapsible={false} name={"externalIdType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"customerNumber","description":"What kind of ID `externalId` is, for example `customerNumber` or `email`."}}></SchemaItem><SchemaItem collapsible={false} name={"identityProviderId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the identity provider of the organisation that the person logs in with, if any."}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Alex Doe","description":"Name of the individual."}}></SchemaItem><SchemaItem collapsible={false} name={"iamId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the login account of the individual at the identity service. The server sets it when the individual has an `email`."}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Email address. With an email address, the server also makes a login account for the individual (for the privacy dashboard). An email address that has an account already gets `400`."}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Phone number."}}></SchemaItem><SchemaItem collapsible={false} name={"pushNotificationToken"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Push notification token of the device of the individual."}}></SchemaItem><SchemaItem collapsible={false} name={"deviceType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [``, `android`, `ios`]"} schema={{"type":"string","description":"Operating system of the device for push notifications. Empty when not set. Any other value gets `400`.","enum":["","android","ios"]}}></SchemaItem><SchemaItem collapsible={false} name={"mapperId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A second ID of your choice, for example the ID of the person in a mobile app. It is unique in the organisation: a second individual with the same mapper ID gets `409`."}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"individual\": {\n    \"id\": \"6af081b138e8f33dcf799628\",\n    \"externalId\": \"customer-1001\",\n    \"externalIdType\": \"customerNumber\",\n    \"identityProviderId\": \"string\",\n    \"name\": \"Alex Doe\",\n    \"iamId\": \"string\",\n    \"email\": \"string\",\n    \"phone\": \"string\",\n    \"pushNotificationToken\": \"string\",\n    \"deviceType\": \"\",\n    \"mapperId\": \"string\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"individual\": {\n    \"id\": \"6af081b138e8f33dcf799628\",\n    \"externalId\": \"customer-1001\",\n    \"externalIdType\": \"customerNumber\",\n    \"identityProviderId\": \"\",\n    \"name\": \"Alex Doe\",\n    \"iamId\": \"3314e64f-b0ab-4078-923f-2250ebbbd9aa\",\n    \"email\": \"reader@example.com\",\n    \"phone\": \"+46700000001\",\n    \"pushNotificationToken\": \"\",\n    \"deviceType\": \"android\",\n    \"mapperId\": \"app-user-2001\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

The API key or the token is missing or not valid.

</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={"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><SchemaItem collapsible={false} name={"errorKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A text code of the refusal that does not change when the text changes. Only some refusals have it, for example `organisation_suspended`, `feature_disabled` or `purpose_exists`."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\",\n  \"errorKey\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

The API key or token does not allow this call. An API key without the scope of the operation gets the older body `{"Code", "Message"}`. An `X-SandboxOrgId` header that names another sandbox organisation than the one of the API key gets `{"errorCode", "errorDescription"}`. When a platform admin has turned off the feature of the operation for the organisation, the answer has `errorKey` `feature_disabled` and the member `feature` (the name of the feature).

</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"}}><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><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><SchemaItem collapsible={false} name={"errorKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A text code of the refusal that does not change when the text changes. Only some refusals have it, for example `organisation_suspended`, `feature_disabled` or `purpose_exists`."}}></SchemaItem></TabItem><TabItem label={"Older error body"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"Code"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The HTTP status.","example":403}}></SchemaItem><SchemaItem collapsible={false} name={"Message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"What went wrong.","example":"Unauthorized access;User doesn't have enough permissions;"}}></SchemaItem></TabItem></SchemaTabs></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"Code\": 403,\n  \"Message\": \"Unauthorized access;User doesn't have enough permissions;\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

No individual has the mapper ID (`Failed to fetch individual by mapper id: <mapperId>`), or the server failed.

</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={"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><SchemaItem collapsible={false} name={"errorKey"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A text code of the refusal that does not change when the text changes. Only some refusals have it, for example `organisation_suspended`, `feature_disabled` or `purpose_exists`."}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\",\n  \"errorKey\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>