Skip to main content
PATCH
/
entities
/
{entity_id}
Update an entity
curl --request PATCH \
  --url https://api.sandbox.monite.com/v1/entities/{entity_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-monite-version: <x-monite-version>' \
  --data '
{
  "address": {
    "city": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "postal_code": "<string>",
    "state": "<string>"
  },
  "email": "jsmith@example.com",
  "individual": {
    "date_of_birth": "2023-12-25",
    "first_name": "<string>",
    "id_number": "<string>",
    "last_name": "<string>",
    "ssn_last_4": "<string>",
    "title": "<string>"
  },
  "organization": {
    "business_structure": "incorporated_partnership",
    "directors_provided": true,
    "executives_provided": true,
    "legal_entity_id": "<string>",
    "legal_name": "<string>",
    "owners_provided": true,
    "representative_provided": true
  },
  "phone": "<string>",
  "registration_authority": "Amtsgericht Charlottenburg",
  "registration_number": "HRB 202324",
  "tax_id": "<string>",
  "website": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "address": {
    "city": "<string>",
    "country": "AF",
    "line1": "<string>",
    "postal_code": "<string>",
    "line2": "<string>",
    "state": "<string>"
  },
  "organization": {
    "legal_name": "<string>",
    "business_structure": "incorporated_partnership",
    "directors_provided": true,
    "executives_provided": true,
    "legal_entity_id": "<string>",
    "owners_provided": true,
    "representative_provided": true
  },
  "status": "active",
  "type": "<string>",
  "email": "<string>",
  "logo": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "file_type": "<string>",
    "md5": "<string>",
    "mimetype": "<string>",
    "name": "<string>",
    "region": "<string>",
    "size": 1,
    "url": "<string>",
    "pages": [],
    "previews": []
  },
  "phone": "<string>",
  "registration_authority": "Amtsgericht Charlottenburg",
  "registration_number": "HRB 202324",
  "tax_id": "<string>",
  "website": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-monite-version
string<date>
required

Path Parameters

​
entity_id
string<uuid>
required

A unique ID to specify the entity.

Example:

"ea837e28-509b-4b6a-a600-d54b6aa0b1f5"

Body

application/json

A schema for a request to update an entity

​
address
object

An address description of the entity

​
email
string<email> | null

An official email address of the entity

​
individual
object

A set of meta data describing the individual

​
organization
object

A set of meta data describing the organization

​
phone
string | null

The contact phone number of the entity. Required for US organizations to use payments.

Maximum string length: 100
​
registration_authority
string | null

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

Required string length: 1 - 100
Example:

"Amtsgericht Charlottenburg"

​
registration_number
string | null

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

Required string length: 1 - 100
Example:

"HRB 202324"

​
tax_id
string | null

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

Required string length: 1 - 30
​
website
string<uri> | null

A website of the entity

Required string length: 1 - 2083

Response

Successful Response

A schema for a response after creation of an entity of different types

​
id
string<uuid>
required

UUID entity ID

​
created_at
string<date-time>
required

UTC datetime

​
updated_at
string<date-time>
required

UTC datetime

​
address
object
required

An address description of the entity

​
organization
object
required

A set of metadata describing an organization

​
status
enum<string>
required

record status, 'active' by default

Available options:
active,
deleted
​
type
string
required

A type for an organization

Allowed value: "organization"
​
email
string | null

An official email address of the entity

​
logo
object

A logo image of the entity

​
phone
string | null

A phone number of the entity

Maximum string length: 100
​
registration_authority
string | null

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

Required string length: 1 - 100
Example:

"Amtsgericht Charlottenburg"

​
registration_number
string | null

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

Required string length: 1 - 100
Example:

"HRB 202324"

​
tax_id
string | null

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

Maximum string length: 30
​
website
string<uri> | null

A website of the entity

Required string length: 1 - 2083