Create Person

post

https://sandbox.api.lemon.markets/v1/persons

Preview: The subsidy application roles and the fields roles, gender, birth_name and social_security_number are a preview API and may change without a deprecation period.

Create a person. A person can be the customer of an individual account, a beneficial owner or legal representative of a business, or the spouse or a child in a subsidy application.

Use roles to say what the person is created for. The required fields depend on the roles:

No roles: registered_address is required. If your account configuration requires agreements, accepted_agreements must contain the latest privacy policy.
subsidy_application.spouse: place_of_birth with city and country, and a tax_residencies entry with a tax_identification_number are required. registered_address is not required.
subsidy_application.child: a tax_residencies entry with a tax_identification_number is required. registered_address is not required.

A person with more than one role needs the required fields of all its roles. Persons with only subsidy application roles cannot accept agreements, so a request with accepted_agreements is rejected with a 400. Roles can only be set when the person is created. If an existing person needs another role, create a new person.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

firstname

string

required

length between 1 and 100

A string describing the person's first name.

lastname

string

required

length between 1 and 100

A string describing the person's lastname.

date_of_birth

date

required

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

birth_name

string

length between 1 and 100

The person's last name at birth (Geburtsname), if it is different from lastname.

gender

string

enum

The person's gender. If not set, the gender is unknown.

Allowed:

registered_address

object

The person's registered address. Required for persons without roles. Not required for persons with only subsidy application roles.

nationalities

array of strings

length ≥ 1

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.

This field is required when creating individual account.

Nationalities

string

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

phone_number

string

length between 1 and 45

A mobile phone number, including the country calling code.

This field is required when creating individual account.

place_of_birth

object

An object representing a place of birth.

This field is required when creating individual account, and for the role
subsidy_application.spouse. For the spouse, city is also required.

tax_residencies

array of objects

length ≥ 1

A list of a person's tax residencies. It is important for this data point to be complete.

This field is required when creating individual account. For the roles subsidy_application.spouse
and subsidy_application.child, at least one entry with a tax_identification_number is required.

Tax Residencies

An object representing a tax residency.

country

string

required

length between 2 and 2

An ISO 3166-1 alpha-2 code, representing a country considering the user one of its tax payers.

tax_identification_number

string

length between 1 and 255

The TIN (Tax Identification Number) related to the user within the taxation regime within country.

social_security_number

string

length between 1 and 255

The person's German social security number (Sozialversicherungsnummer or Rentenversicherungsnummer), or the subsidy number (Zulagenummer) if the person already has one. Optional, also for the subsidy application roles.

roles

array of objects, unique

What the person is created for. The roles decide which fields are required, see Create Person. If not set, the person has no roles. Roles can only be set when the person is created.

accepted_agreements

array of objects

length between 1 and 1

A list of legal agreements that have been accepted by the person. For persons without roles, this field is required if your account configuration requires agreements. Persons with only subsidy application roles cannot accept agreements: the request is rejected with a 400.

Accepted Agreements

An object representing the user's acceptance of a legal agreement at a specific point in time.

agreement_id

string

required

length ≤ 255

An agreement identifier. This value identifies the agreement that a customer has accepted at a certain point in time.

accepted_at

date-time

required

A point in time. This value specifies the point in time at which the user accepted the agreement referenced by agreement_id.

201Successful Response

400Bad Request

401Unauthorized

404Not Found

422Unprocessable Entity

5XXServer Error