DOdotfile
Individuals

Update an individual

Changed on

Updates the individual with the given ID.

patch/v1/individuals/{id}

Request

  • Base URL
    https://api.dotfile.com
  • Auth
    API key in header X-DOTFILE-API-KEY

Path parameters

idstring uuid required

Id of the individual

Request body

first_namestring
middle_namestring nullable

May contain multiple middle names

last_namestring
maiden_namestring nullable
is_business_contactboolean

Set to true if this individual should be contacted regarding the case, this will also make the email required.

is_beneficial_ownerboolean

Set to true if this individual ultimately owns or controls the main company

is_controlling_personboolean

Set to true if this individual exercises control over the main company through means other than ownership (e.g. senior management, board member)

is_delegatorboolean

Set to true if this individual is delegating its signing authority to the signatory of the case.
Individual cannot be both delegator and signatory Not relevant individual cannot be delegator

is_signatoryboolean

Set to true if this person has delegated authority to be a signatory of the case, this will also make the email required.
Individual cannot be both signatory and delegator Not relevant individual cannot be signatory

emailstring email nullable

Required if individual is_business_contact is true. Must be a valid email as defined in the HTML spec (eg. must match the following JavaScript-compatible regular expression: /^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/)

birth_datestring date nullable

Date in format ISO 8601(yyyy-MM-dd eg 2023-01-31)

birth_countrystring alpha-2 nullable

ISO 3166-1 alpha-2 country code (eg FR)

birth_placestring nullable
gender'male' | 'female' | 'other' nullable

Gender of the individual

nationalitiesstring[] nullable

Nationalities of the individual as ISO 3166-1 alpha-2 country codes

tax_identification_numberstring nullable
social_security_numberstring nullable
phone_numberstring e.164 nullable

E.164 phoneNumber (eg +XXXXXXXXXXX)

positionstring nullable
ownership_percentagenumber nullable
voting_rights_percentagenumber nullable
rolesstring[]

legal_representative shareholder

custom_propertiesobject

Optional partial custom properties object in a format of key (string) / value (string | boolean | string[] | number | null) to update the individual.

Archived custom properties are not accepted.

Example request

{
  "banking_information": {
    "iban": "FR7630006000011234567890189",
    "bic": "AGRIFRPPXXX"
  },
  "phone_number": "+33601234567",
  "custom_properties": {
    "custom_text": "Custom properties text",
    "custom_boolean": true,
    "custom_date": "2012-12-12",
    "custom_countries": [
      "FR"
    ],
    "custom_choices": [
      "option1",
      "option2"
    ],
    "custom_numeric": 12.3,
    "custom_property": null
  }
}

Response

Returns information of the updated individual

ℹ️ Click to see full payload

idstring uuid required
case_idstring uuid required
rolesstring[] required

legal_representative shareholder

is_beneficial_ownerboolean required

Set to true if this individual ultimately owns or controls the main company

is_controlling_personboolean required

Set to true if this individual exercises control over the main company through means other than ownership (e.g. senior management, board member)

is_business_contactboolean required

Set to true if this individual should be contacted regarding the case

is_delegatorboolean required

Set to true if this individual is delegating its signing authority to the signatory of the case

is_signatoryboolean required

Set to true if this person has delegated authority to be a signatory of the case

is_relevantboolean required
first_namestring required
middle_namestring nullable required

May contain multiple middle names

last_namestring required
maiden_namestring nullable required
emailstring email nullable required
birth_datestring date nullable required

Date in format ISO 8601(yyyy-MM-dd eg 2023-01-31)

birth_countrystring alpha-2 nullable required

ISO 3166-1 alpha-2 country code (eg FR)

birth_placestring nullable required
gender'male' | 'female' | 'other' nullable required

Gender of the individual

nationalitiesstring[] nullable required

Nationalities of the individual as ISO 3166-1 alpha-2 country codes

tax_identification_numberstring nullable required
social_security_numberstring nullable required
phone_numberstring e.164 nullable required

Phone number in E.164 format (eg +33123456789)
E.164 phoneNumber (eg +XXXXXXXXXXX)

positionstring nullable required
ownership_percentagenumber float nullable required
voting_rights_percentagenumber float nullable required
custom_propertiesobject required

Custom properties object in a format of key (string) / value (string | boolean | string[] | number | null) to read the individual.

Archived custom properties are omitted.

created_atstring date-time required

Creation date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)

updated_atstring date-time required

Latest update date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)

last_activity_atstring date-time required

Latest activity date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)

data_lineageobject

Data lineage keyed by property path, returned only when data_lineage=true is provided.

Example response

{
  "banking_information": {
    "iban": "FR7630006000011234567890189",
    "bic": "AGRIFRPPXXX"
  },
  "phone_number": "+33601234567",
  "custom_properties": {
    "custom_text": "Custom properties text",
    "custom_boolean": true,
    "custom_date": "2012-12-12",
    "custom_countries": [
      "FR"
    ],
    "custom_choices": [
      "option1",
      "option2"
    ],
    "custom_numeric": 12.3,
    "custom_property": null
  }
}

Changes