CommonEntities

Update an entity

Change the specified fields with the provided values.

Path parameters

entity_idstringRequired
A unique ID to specify the entity.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired

Request

This endpoint expects an object.
addressobjectOptional
An address description of the entity
emailstringOptionalformat: "email"
An official email address of the entity
individualobjectOptional
A set of meta data describing the individual
organizationobjectOptional
A set of meta data describing the organization
phonestringOptional<=100 characters
The contact phone number of the entity. Required for US organizations to use payments.
registration_authoritystringOptional>=1 character<=100 characters

(Germany only) The name of the local district court (Amtsgericht) where the entity is registered. Required if registration_number is provided.

registration_numberstringOptional>=1 character<=100 characters

(Germany only) The entity’s commercial register number (Handelsregisternummer) in the German Commercial Register, if available.

tax_idstringOptional>=1 character<=30 characters

The entity’s taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered.

websitestringOptionalformat: "uri">=1 character<=2083 characters
A website of the entity

Response

Successful Response
individualobject
OR
organizationobject

Errors