Legal Entities

Get shareholders for a Merchant Legal Entity

Changed on

Get shareholders for a Merchant Legal Entity

get/api/v1/merchants/{merchantId}/shareholders

Request

Path parameters

merchantIdstring uuid required

The unique identifier of the merchant

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

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174001",
      "ownership_details": {
        "ownership_share": 25,
        "ownership_roles": [
          "owner",
          "director"
        ],
        "id_number": "AB123456",
        "id_issue_country": "GB"
      },
      "legal_entity": {
        "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

    • breaking

      the /// response property's min was decreased from 10.00 to 0.00 for the response status

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status

    • info

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

    • info

      added subschema #1 subschema #2 subschema #3 to the /// response property anyOf list for the response status

    • info

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

    • info

      added discriminator to // response property for the response status

    • info

      the /// response's property pattern ^[A-Za-z]{2}$ was added for the status

    • breaking

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

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