Read individual

GET 
/config/individual/:individualId

This endpoint is used to read an individual info defined for an organisation in the consent building block.

Request

Path Parameters

individualId stringrequired

Unique ID of an object

Responses

200

Response Headers

application/json

Schema

Schema

individual object

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.

id string

The unique ID of an Individual row.

externalId string

Reference to another foundational/functional ID, which is likely PII

externalIdType string

External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.

identityProviderId string

This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.

name stringrequired

Name of the individual

iamId string

Create a user in keycloak and save the id as iamId

email stringrequired

Email Id

phone stringrequired

Phone

Example (from schema)

{
  "individual": {
    "id": "",
    "externalId": "",
    "externalIdType": "",
    "identityProviderId": "",
    "name": "string",
    "iamId": "string",
    "email": "string",
    "phone": "string"
  }
}

400

bad input parameter

Response Headers

Loading...