v1
latestOpenAPI 3.1.02026-07-132363652.9 MBLegal Entities
Create a legal entity for a merchant
Create a legal entity for a merchant
post/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
Example request
{
"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",
"client_evidence": {
"checkout_page_version": "a1b2c3d",
"timezone": "Europe/Dublin",
"consented_agreements": [
{
"kind": "merchant_tos",
"agreement_id": "00000000-0000-0000-0000-000000000001"
},
{
"kind": "quidkey_privacy",
"agreement_id": "00000000-0000-0000-0000-000000000002"
},
{
"kind": "merchant_dpa",
"agreement_id": "00000000-0000-0000-0000-000000000003"
},
{
"kind": "merchant_prohibited_use",
"agreement_id": "00000000-0000-0000-0000-000000000004"
},
{
"kind": "merchant_pricing_plan",
"agreement_id": "00000000-0000-0000-0000-000000000005"
},
{
"kind": "third_party_provider_agreements",
"agreement_id": "00000000-0000-0000-0000-000000000006"
},
{
"kind": "transfermate_authorization",
"agreement_id": "00000000-0000-0000-0000-000000000007"
}
],
"checkbox_language": [
{
"checkbox_id": "consent-quidkey",
"rendered_text": "I confirm I am an authorized representative of this business and agree to Quidkey's …",
"covers_kinds": [
"merchant_tos",
"quidkey_privacy",
"merchant_dpa",
"merchant_prohibited_use",
"merchant_pricing_plan",
"third_party_provider_agreements"
]
},
{
"checkbox_id": "consent-transfermate",
"rendered_text": "I confirm by ticking this box I authorise Quidkey to view and enter transactions with TransferMate on my behalf …",
"covers_kinds": [
"transfermate_authorization"
]
}
]
}
}Response
Created
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"
}
}