Update an entity | Monite Documentation

curl -X PATCH https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5 \
     -H "x-monite-version: 2023-09-01" \
     -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"
}

Change the specified fields with the provided values.

Authentication

AuthorizationBearer

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

Path parameters

entity_idstringRequired

A unique ID to specify the entity.

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_idstringOptional<=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-2083 characters

A website of the entity

Response

Successful Response

individualobject

organizationobject

Errors

400

Patch Entities ID Request Bad Request Error

403

Patch Entities ID Request Forbidden Error

422

Patch Entities ID Request Unprocessable Entity Error

500

Patch Entities ID Request Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors