Legal Entities
Admin

Verify a legal entity

Verify a legal entity

patch/api/v1/admin/legal-entities/{id}/verify

Path parameters

idstring uuid required

The unique identifier of the legal entity

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

The unique identifier of the legal entity

Request body

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"
  }
}

Changes

Changed in 4 of the 8 revisions of this API.8256

  • b372e7d5563d314See the full diff
    • added subschema #1: Company Legal Entity subschema #2: Individual Legal Entity to the response property oneOf list for the response status

      response-property-one-of-added

    • the response's property type changed from no type to object for status

      response-property-type-changed

    • the / response's property type changed from string to no type for status

      response-property-type-changed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • added the optional property / to the response with the status

      response-optional-property-added

    • added subschema #1 subschema #2 to the / response property allOf list for the response status

      response-property-all-of-added

    • removed subschema #1: Company Legal Entity subschema #2: Individual Legal Entity from the response property anyOf list for the response status

      response-property-any-of-removed

    • added discriminator to response property for the response status

      response-property-discriminator-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 113baf4763844241See the full diff
    • the response's property type changed from object to no type for status

      response-property-type-changed

    • removed the required property / from the response with the status

      response-required-property-removed

    • removed the required property / from the response with the status

      response-required-property-removed

    • removed the required property / from the response with the status

      response-required-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • removed the optional property / from the response with the status

      response-optional-property-removed

    • added subschema #1: Company Legal Entity subschema #2: Individual Legal Entity to the response property anyOf list for the response status

      response-property-any-of-added

    • endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 367 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog