Create individual
POST/config/individual
This endpoint creates an individual for an organisation in the consent building block. This is used to onboard existing or new users.
Request
- application/json
Body
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.
The unique ID of an Individual row.
Reference to another foundational/functional ID, which is likely PII
External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.
This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.
Name of the individual
Create a user in keycloak and save the id as iamId
Email Id
Phone
Responses
- 200
- 400
Response Headers
- application/json
- Schema
- Example (from 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.
The unique ID of an Individual row.
Reference to another foundational/functional ID, which is likely PII
External id type specifier. A string. For instance "email" or "foundational id". Can be used in later queries.
This could be an FK, but for now we do not have a mapping of identity providers. IDBB may have more requirements.
Name of the individual
Create a user in keycloak and save the id as iamId
Email Id
Phone
{
"individual": {
"id": "",
"externalId": "",
"externalIdType": "",
"identityProviderId": "",
"name": "string",
"iamId": "string",
"email": "string",
"phone": "string"
}
}
bad input parameter