Individual

Create individual

POST/v4/service/platform/individual

Creates an individual from your app or website, for example when a new user signs up. Keep the returned id: the consent record routes take it in the X-ConsentBB-IndividualId header. This route takes an API key only; a key with only the individual:create scope (individuals:create) is enough.

No member is mandatory. Use externalId to link the individual to your own user ID. With an email, the server also makes a login account for the individual. Keep personal data to the minimum that you need.

Create individual

Language of the request sample

curl -X POST 'https://demo-api.igrant.io/v4/service/platform/individual' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "individual": {
    "externalId": "customer-1002",
    "externalIdType": "customerNumber",
    "name": "Sam Doe"
  }
}'

{
  "individual": {
    "id": "6af0821c38e8f33dcf79962e",
    "externalId": "customer-1002",
    "externalIdType": "customerNumber",
    "identityProviderId": "",
    "name": "Sam Doe",
    "iamId": "",
    "email": "",
    "phone": "",
    "pushNotificationToken": "",
    "deviceType": "",
    "mapperId": ""
  }
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:individuals:create

Body

application/json

individualobjectrequired
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.

Response

application/json

The new individual.

individualobject
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.