CommonEntities

Update an entity of this user

Update the entity to which the authenticated user belongs.

This endpoint requires an entity user access token. The user must have a role with the entity.update permission.

This endpoint does not use the X-Monite-Entity-Id header. The entity ID is inferred from the access token.

Related endpoints:

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 new taxpayer identification number (tax ID) of the entity. Tax ID is required for entities that are not VAT-registered.

Note: If an entity that is onboarded for payments updates its tax ID, this entity must re-accept the Monite payments terms of service (ToS) to continue using payments. To accept the ToS, call PATCH /entities/{entity_id}/onboarding_data and provide the new tos_acceptance.date timestamp. This timestamp must be later than the time when the tax_id was last updated.

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

Response

Successful Response
individualobject
OR
organizationobject

Errors