Update a Legal Entity

Update a legal entity of your business.

A legal entity can be updated, if it has not been used in any submitted transactions. When transactions are connected to it, it can not be updated anymore. Instead, create a new legal entity.

Update a legal entity of your business

patch

Update a legal entity of your business

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

application/json

namestringOptional

Business's name

Example: Example Palm Oil Trader

emailobject · nullableOptional

email of the contact person in the business

Example: [email protected]

addressCitystringOptional

City of the business's address

Example: West Papua

addressCountryCodestringOptional

Two-letter country code (ISO 3166 Alpha-2) of the business's address

Example: ID

addressLine1stringOptional

First line of the business address

Example: Salawati 123

addressLine2object · nullableOptional

Second line of the business address

Example: 2nd floor

addressPostcodestringOptional

Country-specific postcode of the business's address

Example: 12345

eoriobject · nullableOptional

EORI number of the business

vatobject · nullableOptional

VAT number of the business

Example: 1234567890asdfghjk

Responses

200

Returns the updated legal entity.

application/json

namestringRequired

Business's name

Example: Example Palm Oil Trader

emailobject · nullableOptional

email of the contact person in the business

Example: [email protected]

addressCitystringRequired

City of the business's address

Example: West Papua

addressCountryCodestringRequired

Two-letter country code (ISO 3166 Alpha-2) of the business's address

Example: ID

addressLine1stringRequired

First line of the business address

Example: Salawati 123

addressLine2object · nullableRequired

Second line of the business address

Example: 2nd floor

addressPostcodestringRequired

Country-specific postcode of the business's address

Example: 12345

eoriobject · nullableOptional

EORI number of the business

vatobject · nullableOptional

VAT number of the business

Example: 1234567890asdfghjk

idstringRequired

id of this entity

Example: 123e4567-e89b-12d3-a456-426614174000

createdAtstring · date-timeRequired

ISO 8601

Example: 2021-01-01T00:00:00.000Z

updatedAtstring · date-timeRequired

ISO 8601

Example: 2021-01-01T00:00:00.000Z

400Error

401Error

403Error

404Error

patch

/legal-entities/{id}

HTTPcURLJavaScriptPython

PATCH /legal-entities/{id} HTTP/1.1
Host: api.tradeaware.live-eo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 234

{
  "name": "Example Palm Oil Trader",
  "email": "[email protected]",
  "addressCity": "West Papua",
  "addressCountryCode": "ID",
  "addressLine1": "Salawati 123",
  "addressLine2": "2nd floor",
  "addressPostcode": "12345",
  "eori": {},
  "vat": "1234567890asdfghjk"
}

{
  "name": "Example Palm Oil Trader",
  "email": "[email protected]",
  "addressCity": "West Papua",
  "addressCountryCode": "ID",
  "addressLine1": "Salawati 123",
  "addressLine2": "2nd floor",
  "addressPostcode": "12345",
  "eori": {},
  "vat": "1234567890asdfghjk",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "updatedAt": "2021-01-01T00:00:00.000Z"
}