Sign in

v1

latestOpenAPI 3.1.02026-07-132363652.9 MB
Legal Entities

Partially update a legal entity for a merchant

Partially update a legal entity for a merchant

patch/api/v1/merchants/{id}/legal-entities

Path parameters

idstring uuid required

The unique identifier of the merchant

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

The unique identifier of the merchant

Request body

OR

Example request

{
  "id": "123e4567-e89b-12d3-a456-426614174001",
  "type": "company",
  "company_name": "Example Company",
  "company_number": "12345678",
  "vat_number": "GB123456789",
  "tax_id": "12345678901",
  "country_of_incorporation": "GB",
  "incorporation_date": "2024-01-01",
  "registered_office_address": {
    "address_line1": "12 West Common Drive",
    "address_line2": "Flat 1",
    "apartment": "Apt 5B",
    "city": "London",
    "state_province": "Greater London",
    "country": "GB",
    "postal_code": "SE1 1AA",
    "company_name": "Acme Ltd"
  },
  "company_operating_address": {
    "address_line1": "12 West Common Drive",
    "address_line2": "Flat 1",
    "apartment": "Apt 5B",
    "city": "London",
    "state_province": "Greater London",
    "country": "GB",
    "postal_code": "SE1 1AA",
    "company_name": "Acme Ltd"
  },
  "contact_name": "Jane Doe",
  "contact_email": "jane.doe@example.com",
  "contact_phone_number": "44;7395236209",
  "annual_revenue_amount": 1000000,
  "annual_revenue_currency": "GBP"
}

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174001",
    "verification_required": true,
    "verification_link": "https://verify.example.com/entity/123",
    "type": "company",
    "company_name": "Example Company",
    "company_number": "12345678",
    "vat_number": "GB123456789",
    "tax_id": "12345678901",
    "country_of_incorporation": "GB",
    "incorporation_date": "2024-01-01",
    "registered_office_address": {
      "address_line1": "12 West Common Drive",
      "address_line2": "Flat 1",
      "apartment": "Apt 5B",
      "city": "London",
      "state_province": "Greater London",
      "country": "GB",
      "postal_code": "SE1 1AA",
      "company_name": "Acme Ltd"
    },
    "company_operating_address": {
      "address_line1": "12 West Common Drive",
      "address_line2": "Flat 1",
      "apartment": "Apt 5B",
      "city": "London",
      "state_province": "Greater London",
      "country": "GB",
      "postal_code": "SE1 1AA",
      "company_name": "Acme Ltd"
    },
    "contact_name": "Jane Doe",
    "contact_email": "jane.doe@example.com",
    "contact_phone_number": "44;7395236209",
    "annual_revenue_amount": 1000000,
    "annual_revenue_currency": "GBP"
  }
}