Sign in

v1

latestOpenAPI 3.1.02026-07-2496304466.3 KB
Persons

Create Person Data Update Request

post/persons/{person_id}/updates

Path parameters

person_idstring required

A person identifier.

Headers

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

Request body

OR
OR
OR
OR

Example request

{
  "email": "newemail@example.com"
}

Response

Successful Response

idstring required

A unique identifier for the person data update request.

type'email' | 'phone_number' | 'registered_address' | 'employment' | 'tax_residencies' required

The discriminator identifying which field is being updated.

emailstring email

The new email address for the person when type is email.

numberstring

The new phone number for the person, including the country calling code, when type is phone_number.

line_1string

The first line of the address when type is registered_address.

line_2string nullable

An optional second line of the address when type is registered_address.

postal_codestring

The postal code or ZIP code of the address when type is registered_address.

citystring

The city or municipality of the address when type is registered_address.

countrystring

An ISO 3166-1 alpha-2 code representing the country when type is registered_address.

status'apprenticeship' | 'company_owner' | 'employed' | 'managing_director' | 'public_official' | 'retired' | 'self_employed' | 'student' | 'unemployed'

A category to represent a user's employment status:

<ul> <li><code>apprenticeship</code> <li><code>company_owner</code> <li><code>employed</code> <li><code>managing_director</code> <li><code>public_official</code> <li><code>retired</code> <li><code>self_employed</code> <li><code>student</code> <li><code>unemployed</code> </ul>
annual_salary'lt_50k_eur' | 'gte_50k_lt_75k_eur' | 'gte_75k_lt_100k_eur' | 'gte_100k_lt_150k_eur' | 'gte_150k_eur'

A category to represent a customer's annual income:

<ul> <li><code>lt_50k_eur</code>: Less than 50,000 EUR. <li><code>gte_50k_lt_75k_eur</code>: 50,000 EUR or more, but less than 75,000 EUR. <li><code>gte_75k_lt_100k_eur</code>: 75,000 EUR or more, but less than 100,000 EUR. <li><code>gte_100k_lt_150k_eur</code>: 100,000 EUR or more, but less than 150,000 EUR. <li><code>gte_150k_eur</code>: 150,000 EUR or more. </ul>
sector'agriculture' | 'commodities' | 'construction' | 'education' | 'financial_services' | 'gambling' | 'healthcare' | 'it' | 'jewellery_trading' | 'manufacturing' | 'precious_metals_trading' | 'professional_services' | 'public_sector' | 'real_estate' | 'retail' | 'service_industry' | 'sport' | 'tourism' | 'transport' | 'used_vehicles_trading' | 'weapons_trading' | 'other'

A category representing the industry sector related to a user's employment status. If the user's employment status is not directly linked to a sector, select other.

<ul> <li><code>agriculture</code></li> <li><code>commodities</code></li> <li><code>construction</code></li> <li><code>education</code></li> <li><code>financial_services</code></li> <li><code>gambling</code></li> <li><code>healthcare</code></li> <li><code>it</code></li> <li><code>jewellery_trading</code></li> <li><code>manufacturing</code></li> <li><code>precious_metals_trading</code></li> <li><code>professional_services</code></li> <li><code>public_sector</code></li> <li><code>real_estate</code></li> <li><code>retail</code></li> <li><code>service_industry</code></li> <li><code>sport</code></li> <li><code>tourism</code></li> <li><code>transport</code></li> <li><code>used_vehicles_trading</code></li> <li><code>weapons_trading</code></li> <li><code>other</code></li> </ul>

Example response

{
  "id": "upd_4ffa7b6928e6466ba8c13badb49f8add",
  "email": "newemail@example.com",
  "number": "+49172997319",
  "line_1": "Neue Straße 1",
  "postal_code": "10115",
  "city": "Berlin",
  "country": "DE",
  "residencies": [
    {
      "country": "DE",
      "tax_identification_number": "12345"
    }
  ]
}