v1

latestOpenAPI 3.1.02026-07-2496304466.3 KB
Persons

Create Person

post/persons

Headers

LMG-Data-Privacy-Access-Principalstring required
LMG-Data-Privacy-Access-Justificationstring required

Request body

firstnamestring required

A string describing the person's first name.

lastnamestring required

A string describing the person's lastname.

date_of_birthstring date required

A string describing the day of birth, like "1964-08-13".

nationalitiesstring[]

A complete list of ISO 3166-1 alpha-2 codes, representing each country related to a user's nationalities/citizenships. It is important for this data point to be complete.

emailstring email

A verified email address to contact the user. This email address must match the one you have on record for the user.

phone_numberstring

A mobile phone number, including the country calling code.

Example request

{
  "firstname": "Erika",
  "lastname": "Mustermann",
  "date_of_birth": "1964-08-13",
  "registered_address": {
    "line_1": "Heidestraße 17",
    "postal_code": "51147",
    "city": "Köln",
    "country": "DE"
  },
  "nationalities": [
    "DE"
  ],
  "email": "erika.mustermann@example.com",
  "phone_number": "+49172997318",
  "place_of_birth": {
    "city": "Berlin",
    "country": "DE"
  },
  "tax_residencies": [
    {
      "country": "DE"
    }
  ],
  "accepted_agreements": [
    {
      "agreement_id": "agr_9902271f791d413aad781763c61b9bb0",
      "accepted_at": "2023-06-29T14:39:29Z"
    }
  ]
}

Response

Successful Response

idstring required

The identifier representing this person.

firstnamestring required

A string describing the person's first name.

lastnamestring required

A string describing the person's lastname.

date_of_birthstring date required

A string describing the day of birth, like "1964-08-13".

nationalitiesstring[]

A complete list of ISO 3166-1 alpha-2 codes, representing each country related to a user's nationalities/citizenships. It is important for this data point to be complete.

emailstring

A verified email address to contact the user. This email address must match the one you have on record for the user.

phone_numberstring

A mobile phone number, including the country calling code.

Example response

{
  "registered_address": {
    "line_1": "Heidestraße 17",
    "postal_code": "51147",
    "city": "Köln",
    "country": "DE"
  },
  "phone_number": "+49172997318",
  "place_of_birth": {
    "city": "Berlin",
    "country": "DE"
  },
  "tax_residencies": [
    {
      "country": "DE"
    }
  ]
}