Update an entity of this user

PATCH

/entity_users/my_entity

PATCH

/v1/entity_users/my_entity

curl -X PATCH https://api.sandbox.monite.com/v1/entity_users/my_entity \
     -H "x-monite-version: 2024-05-25" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "type": "individual",
  "address": {
    "city": "city",
    "country": "AF",
    "line1": "line1",
    "postal_code": "postal_code",
    "line2": "line2",
    "state": "state"
  },
  "created_at": "2024-01-15T09:30:00Z",
  "id": "id",
  "individual": {
    "first_name": "first_name",
    "last_name": "last_name",
    "date_of_birth": "date_of_birth",
    "id_number": "id_number",
    "ssn_last_4": "ssn_last_4",
    "title": "title"
  },
  "status": "active",
  "updated_at": "2024-01-15T09:30:00Z",
  "email": "email",
  "logo": {
    "id": "id",
    "created_at": "2024-01-15T09:30:00Z",
    "file_type": "payables",
    "md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
    "mimetype": "application/pdf",
    "name": "invoice.pdf",
    "region": "eu-central-1",
    "size": 24381,
    "url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
    "pages": [
      {
        "id": "id",
        "mimetype": "image/png",
        "number": 0,
        "size": 21972,
        "url": "https://bucket.s3.amazonaws.com/123/456.png"
      }
    ],
    "previews": [
      {
        "height": 400,
        "url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
        "width": 200
      }
    ]
  },
  "phone": "phone",
  "registration_authority": "registration_authority",
  "registration_number": "registration_number",
  "tax_id": "tax_id",
  "website": "website"
}

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:

Update the entity to which the authenticated user belongs. This endpoint requires an [entity user access token](https://docs.monite.com/api/concepts/authentication#entity-user-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: * [Update entity settings](https://docs.monite.com/api/entities/patch-entities-id-settings) * [Update entity logo](https://docs.monite.com/api/entities/put-entities-id-logo)

Authentication

AuthorizationBearer

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

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_authoritystringOptional1-100 characters

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

registration_numberstringOptional1-100 characters

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

tax_idstringOptional1-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-2083 characters

A website of the entity

Response

Successful Response

individualobject

organizationobject

Errors

400

Patch Entity Users MY Entity Request Bad Request Error

401

Patch Entity Users MY Entity Request Unauthorized Error

422

Patch Entity Users MY Entity Request Unprocessable Entity Error

429

Patch Entity Users MY Entity Request Too Many Requests Error

Authentication

Headers

Request

Response

Errors