Skip to main content

CreateStakeHolderResponseBody

Response body for stakeholder creation

uiduuidnullable

Unique identifier of the created stakeholder (null if creation failed)

Default value:
Example: 123e4567-e89b-12d3-a456-426614174000
invalidRequest object
oneOf
typestringrequired

Type of stakeholder (person or company)

Default value:
Example: person
firstNamestring | nullnullable

First name of the person (required for type=person)

Default value:
Example: John
lastNamestring | nullnullable

Last name of the person (required for type=person)

Default value:
Example: Doe
companyNamestring | nullnullable

Company name (required for type=company)

Default value:
Example: Acme Corporation
sirenstring | nullnullable

SIREN number for company (required for type=company)

Default value:
Example: 123456789
addressstring | nullnullable

Address of the company

Default value:
postalCodestring | nullnullable

Postal code of the company

Default value:
citystring | nullnullable

City of the company

Default value:
externalCodestring | nullnullable

External code of the company

Default value:
contactsDetails object[]

Contact details of the company

  • Array [
    • emailstring | nullnullable

    Email address of the contact (required for type=person/company)

    Default value:
    Example: john.doe@example.com
    phoneNumberstring | nullnullable

    Phone number of the contact (not required)

    Default value:
    Example: 0123456789
    additionalInfosstring | nullnullable

    Additional infos of the contact (not required)

    Default value:
  • ]
    • isActivebooleanrequired

    Contact active status of the company or person

    Default value: false
    faxstring | nullnullable

    Fax of the company

    Default value:
    functionstring | nullnullable

    Function of the person

    Default value:
    errorstring | nullnullable

    Error message (present only if there was an error)

    Default value:
    Example: Your request could not be processed. Please try again later or contact support.
    CreateStakeHolderResponseBody
    {
      "uid": "123e4567-e89b-12d3-a456-426614174000",
      "invalidRequest": {
        "type": "person",
        "firstName": "John",
        "lastName": "Doe",
        "companyName": "Acme Corporation",
        "siren": "123456789",
        "address": "",
        "postalCode": "",
        "city": "",
        "externalCode": "",
        "contactsDetails": "",
        "isActive": false,
        "fax": "",
        "function": ""
      },
      "error": "Your request could not be processed. Please try again later or contact support."
    }