Account Information10

Admin13

Agreement2

Auth4

Bank Predictions1

Banks9

Branding14

Command Palette2

Countries3

CrossBorder5

Customer Bank Accounts4

Customers3

Dashboard1

Default Rates3

Embedded8

Evidence1

Go Live2

Invoice10

Legal1

Legal Entities11

Merchant Bank Account Payment Schemes1

Merchant Bank Accounts6

Merchant Documents2

Merchant Invitations4

Merchant Rates3

Merchants16

Onboarding3

Partner Invitations4

Partners6

Payment1

Payment Links6

Payment Schemes1

Payments8

Payout6

Post-Processor Logs2

Provider Configuration4

Refund Resolution Links4

Refunds1

Seeds2

Shareholder Documents2

Shareholder Invitations7

Shopify Orders3

Transaction Updates (Token)3

Transactions14

User Invitations2

Users10

Webhook3

Webhooks5

Legal Entities

Create a shareholder for a Merchant Legal Entity

Changed on Jun 17, 2026

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

Request

Base URL
https://core.quidkey.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/banqzinc/apis/quidkey-api/docs/api/v1/merchants/:merchantId/shareholders/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

merchantIdstring uuid required

The unique identifier of the merchant

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

Request body

Example request

{
  "ownership_details": {
    "ownership_share": 25,
    "ownership_roles": [
      "owner",
      "director"
    ],
    "id_number": "AB123456",
    "id_issue_country": "GB"
  },
  "legal_entity": {
    "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

Created

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

Jun 17, 2026b372e7d5563d Revision changes
- breaking
  removed subschema #1: Company Legal Entity Input subschema #2: Individual Legal Entity Input from the request property anyOf list
- breaking
  added the pattern ^[A-Za-z]{2}$ to the request property /
- breaking
  the request property type changed from no type to object
- breaking
  the / request property type changed from string to no type
- 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 subschema #1 subschema #2 subschema #3 to the / request property anyOf list
- info
  added discriminator to request property
- info
  the / request property's min was decreased from 10.00 to 0.00
- info
  added subschema #1: Company Legal Entity Input subschema #2: Individual Legal Entity Input to the request property oneOf list
- 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
Nov 5, 2025113baf476384 Revision changes
- breaking
  the request property type changed from object to no type
- breaking
  the / response's property type changed from object to no type for status
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- 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 Input subschema #2: Individual Legal Entity Input to the request property anyOf list
- info
  added subschema #1: Company Legal Entity subschema #2: Individual Legal Entity to the / response property anyOf list for the response status

Operation history (4 revisions)

Create a shareholder for a Merchant Legal Entity

Request

Path parameters

Request body

Example request

Response 201Created

Example response

Changes

Response