--- title: "Get entity details" method: GET path: "/accounts/entities/{id}" tags: ["Onboarding", "Platforms"] --- # Get entity details `GET /accounts/entities/{id}` ## Request - Base URL: `https://{prefix}.api.sandbox.checkout.com` - URL: `https://{prefix}.api.sandbox.checkout.com/accounts/entities/{id}` - Auth: OAuth 2 - Client credentials - Token URL: `string` scopes: `accounts` - TypeScript: (a function with typed inputs; its response is checked against the schema) Use this endpoint to retrieve an entity and its full details. ## Response `200` Entity retrieved successfully - union - GBCompanyFull30 - `reference` string, required: A unique reference you can later use to identify the sub-entity. - `status` string - `is_draft` boolean: Specifies whether the sub-entity details are in draft. Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks. - `profile` object, required: Information about the profile of the sub-entity, primarily regarding the products/services offered. - `urls` string[], required: A collection of website URLs the sub-entity accepts payments on. - `mccs` unknown[], required: Select the categories that most closely describe the business - unknown - `default_holding_currency` unknown, required - `holding_currencies` string[], required: Incoming funds are held in your selected currencies - `contact_details` object, required: Contact details of this sub-entity. - `phone` object: Phone number - `country_code` 'GI' | 'CH' | 'GG' | 'IM' | 'JE' | 'GB', required: The country code (iso-3166-1 alpha-2) where the phone number is registered - `number` string, required: The phone number without the country calling code - `email_addresses` object: Email addresses for this sub-entity. - `primary` unknown, required - `invitee` object: The details of the user responsible for onboarding the sub-entity. - `email` unknown - `capabilities` object: The capabilities of the entity. - `requirements_due` object[]: List of requirements due in order to be onboarded. - `field` string: The field that is needs to be addressed. - `reason` string: The reason behind the field needing attention. - `message` string: A more descriptive message. - `company` object, required: Information about the company represented by the sub-entity. - `legal_name` string, required: The legal name of the sub-entity. - `trading_name` string, required: The trading name of the sub-entity, also referred to as 'doing business as'. - `business_registration_number` unknown, required - `date_of_incorporation` object, required: The date the company was incorporated. - `day` integer: The day of the month the company was incorporated. - `month` integer, required: The month the company was incorporated. - `year` integer, required: The year the company was incorporated. - `principal_address` object, required: The primary location of the company where business is performed. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `registered_address` object, required: The registered address of the company. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `representatives` union[], required: Information about representatives of this company. - union - object: Personal information about the individual representing the sub-entity. - `id` unknown - `individual` object, required: Information about the individual representing the sub-entity. - … - `company_position` 'ceo' | 'cfo' | 'coo' | 'managing_member' | 'general_partner' | 'president' | 'vice_president' | 'treasurer' | 'other_senior_management' | 'other_executive_officer' | 'other_non_executive_non_senior': The position of the representative within the company. - `roles` string[], required: The individual's roles within the company - `ownership_percentage` integer: The percentage ownership of the UBO or controlling company (required when over 25%) - `documents` object: Verification documents for the individual representative - … - object: Information about the controlling company - `id` unknown - `company` object, required - … - `ownership_percentage` integer: The percentage ownership of the UBO or controlling company (required when over 25%) - `business_type` 'individual_or_sole_proprietorship' | 'limited_company' | 'public_limited_company' | 'limited_partnership' | 'general_partnership' | 'scottish_limited_partnership' | 'government_agency' | 'non_profit_entity' | 'trust' | 'club_or_society' | 'unincorporated_association', required: The legal type of the company - `processing_details` object, required: Seller processing details. - `settlement_country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) where the settlement bank account is located - `target_countries` string[], required: Target country codes (iso-3166-1 alpha-2) with more than 10% expected volume processing with Checkout - `annual_processing_volume` integer, required: The estimated annual processing volume. In minor units without decimals. - `average_transaction_value` integer, required: The expected average transaction value. In minor units without decimals. - `highest_transaction_value` integer, required: The expected highest transaction value. In minor units without decimals. - `currency` 'GBP', required: The currency used for the processing details provided. - `documents` object, required: The documents used to support the verification of company details. - `company_verification` object: Certified by a power of attorney within the last 3 months - `type` 'incorporation_document', required: The type of document used for company verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `articles_of_association` object, required: Memorandum or Articles of Association document - `type` 'memorandum_of_association' | 'articles_of_association', required: The type of document used for company verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `bank_verification` object: A document showing transactions from the last 3 months or an official bank letter. - `type` 'bank_statement' | 'bank_letter', required: The type of document being used as bank verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `shareholder_structure` object, required: Shareholder structure chart (including % of shares) certified by a competent authority individual and dated within last 3 months - `type` 'certified_shareholder_structure', required: The type of document. - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `proof_of_legality` object: A regulatory licence document required for the company to operate (when applicable) - `type` 'proof_of_legality', required: The type of document used for proof of legality - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `proof_of_principal_address` object: Proof of principal place of business - `type` 'proof_of_address', required: The type of document being used as address verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `additional_document1` object: Additional space for documents to be provided when requested - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `additional_document2` object: Additional space for documents to be provided when requested - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `additional_document3` object: Additional space for documents to be provided when requested - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - EEACompanyFull30 - `reference` string, required: A unique reference you can later use to identify the sub-entity. - `status` string - `is_draft` boolean: Specifies whether the sub-entity details are in draft. Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks. - `profile` object, required: Information about the profile of the sub-entity, primarily regarding the products/services offered. - `urls` string[], required: A collection of website URLs the sub-entity accepts payments on. - `mccs` unknown[], required: Select the categories that most closely describe the business - unknown - `default_holding_currency` unknown, required - `holding_currencies` string[], required: Incoming funds are held in your selected currencies - `contact_details` object: Contact details of this sub-entity. - `phone` object: Phone number - `country_code` 'GR' | 'NL' | 'BE' | 'FR' | 'ES' | 'PT' | 'LU' | 'IE' | 'IS' | 'MT' | 'CY' | 'FI' | 'BG' | 'HU' | 'LT' | 'LV' | 'EE' | 'AD' | 'HR' | 'SI' | 'IT' | 'RO' | 'CZ' | 'SK' | 'LI' | 'AT' | 'DK' | 'SE' | 'NO' | 'PL' | 'DE', required: The country code (iso-3166-1 alpha-2) where the phone number is registered - `number` string, required: The phone number without the country calling code - `email_addresses` object: Email addresses for this sub-entity. - `primary` unknown, required - `invitee` object: The details of the user responsible for onboarding the sub-entity. - `email` unknown - `capabilities` object: The capabilities of the entity. - `requirements_due` object[]: List of requirements due in order to be onboarded. - `field` string: The field that is needs to be addressed. - `reason` string: The reason behind the field needing attention. - `message` string: A more descriptive message. - `company` object, required: Information about the company represented by the sub-entity. - `legal_name` string, required: The legal name of the sub-entity. - `trading_name` string, required: The trading name of the sub-entity, also referred to as 'doing business as'. - `business_registration_number` unknown, required - `date_of_incorporation` object, required: The date the company was incorporated. - `day` integer: The day of the month the company was incorporated. - `month` integer, required: The month the company was incorporated. - `year` integer, required: The year the company was incorporated. - `regulatory_licence_number` unknown - `principal_address` object, required: The primary location of the company where business is performed. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `registered_address` object, required: The registered address of the company. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `representatives` union[], required: Information about representatives of this company. - union - object: Personal information about the individual representing the sub-entity. - `id` unknown - `individual` object, required: Information about the individual representing the sub-entity. - … - `company_position` 'ceo' | 'cfo' | 'coo' | 'managing_member' | 'general_partner' | 'president' | 'vice_president' | 'treasurer' | 'other_senior_management' | 'other_executive_officer' | 'other_non_executive_non_senior': The position of the representative within the company. - `roles` string[], required: The individual's roles within the company - `ownership_percentage` integer: The percentage ownership of the UBO or controlling company (required when over 25%) - `documents` object: Verification documents for the individual representative - … - object: Information about the controlling company - `id` unknown - `company` object, required - … - `ownership_percentage` integer: The percentage ownership of the UBO or controlling company (required when over 25%) - `business_type` 'individual_or_sole_proprietorship' | 'limited_company' | 'public_limited_company' | 'limited_partnership' | 'general_partnership' | 'government_agency' | 'non_profit_entity' | 'trust' | 'club_or_society' | 'unincorporated_association', required: The legal type of the company - `processing_details` object, required - `settlement_country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) where the settlement bank account is located - `target_countries` string[], required: Target country codes (iso-3166-1 alpha-2) with more than 10% expected volume processing with Checkout - `annual_processing_volume` integer, required: The estimated annual processing volume. In minor units without decimals. - `average_transaction_value` integer, required: The expected average transaction value. In minor units without decimals. - `highest_transaction_value` integer, required: The expected highest transaction value. In minor units without decimals. - `currency` 'EUR', required: The currency used for the processing details provided. - `documents` object, required: The documents used to support the verification of company details. - `company_verification` object, required: Certified by a power of attorney within the last 3 months - `type` 'incorporation_document', required: The type of document used for company verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `articles_of_association` object, required: Memorandum or Articles of Association document - `type` 'memorandum_of_association' | 'articles_of_association', required: The type of document used for company verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `bank_verification` object, required: A document showing transactions from the last 3 months or an official bank letter. - `type` 'bank_statement' | 'bank_letter', required: The type of document being used as bank verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `shareholder_structure` object, required: Shareholder structure chart (including % of shares) certified by a competent authority individual and dated within last 3 months - `type` 'certified_shareholder_structure', required: The type of document. - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `proof_of_legality` object: A regulatory licence document required for the company to operate (when applicable) - `type` 'proof_of_legality', required: The type of document used for proof of legality - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `proof_of_principal_address` object: Proof of principal place of business - `type` 'proof_of_address', required: The type of document being used as address verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `additional_document1` object: Additional space for documents to be provided when requested - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `additional_document2` object: Additional space for documents to be provided when requested - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `additional_document3` object: Additional space for documents to be provided when requested - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - USCompanyFull30 - `reference` string, required: A unique reference you can later use to identify the sub-entity. - `status` string - `is_draft` boolean: Specifies whether the sub-entity details are in draft. Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks. - `profile` object, required: Information about the profile of the sub-entity, primarily regarding the products/services offered. - `urls` string[], required: A collection of website URLs the sub-entity accepts payments on. - `mccs` unknown[], required: Select the categories that most closely describe the business - unknown - `default_holding_currency` unknown, required - `holding_currencies` string[], required: Incoming funds are held in your selected currencies - `contact_details` object, required: Contact details of this sub-entity. - `phone` object: Phone number - `country_code` 'US', required: The country code (iso-3166-1 alpha-2) where the phone number is registered - `number` string, required: The phone number without the country calling code - `email_addresses` object: Email addresses for this sub-entity. - `primary` unknown, required - `invitee` object: The details of the user responsible for onboarding the sub-entity. - `email` unknown - `capabilities` object: The capabilities of the entity. - `requirements_due` object[]: List of requirements due in order to be onboarded. - `field` string: The field that is needs to be addressed. - `reason` string: The reason behind the field needing attention. - `message` string: A more descriptive message. - `company` object, required: Information about the company represented by the sub-entity. - `legal_name` string, required: The legal name of the sub-entity. - `trading_name` string, required: The trading name of the sub-entity, also referred to as 'doing business as'. - `business_registration_number` unknown, required - `date_of_incorporation` object, required: The date the company was incorporated. - `day` integer: The day of the month the company was incorporated. - `month` integer, required: The month the company was incorporated. - `year` integer, required: The year the company was incorporated. - `principal_address` object, required: The primary location of the company where business is performed. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `registered_address` object, required: The registered address of the company. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` 'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'AS' | 'GU' | 'MP' | 'PR' | 'VI' | 'UM', required: The address state. This field is required for addresses based in the US. For US addresses, provide the state as an ISO 3166-1 code. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `representatives` object[], required: Information about representatives of this company. - `id` unknown - `individual` object, required: Information about the individual representing the sub-entity. - `first_name` string, required: The representative's first name. - `middle_name` string: The representative's middle name. Required if appears in official docs - `last_name` string, required: The representative's last name. - `date_of_birth` object, required: The date of birth of the person according to the Gregorian calendar. - `day` integer, required: The calendar day of the month they were born. - `month` integer, required: The month of the year they were born. - `year` integer, required: The year they were born. - `place_of_birth` object, required: The place of birth of the person. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `national_id_number` unknown - `email_address` unknown - `phone` object: Phone number - `country_code` 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BR' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CO' | 'KM' | 'CD' | 'CG' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'BQ' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UY' | 'UZ' | 'VU' | 'VA' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW', required: The country code (iso-3166-1 alpha-2) where the phone number is registered - `number` string, required: The phone number without the country calling code - `address` object, required: The representative's address. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `company_position` 'ceo' | 'cfo' | 'coo' | 'managing_member' | 'general_partner' | 'president' | 'vice_president' | 'treasurer' | 'other_senior_management' | 'other_executive_officer' | 'other_non_executive_non_senior': The position of the representative within the company. - `roles` string[], required: The individual's roles within the company - `ownership_percentage` integer: The percentage ownership of the UBO or controlling company (required when over 25%) - `documents` object: Verification documents for the individual representative - `identity_verification` object: The document to use to confirm the individual's identity. - `type` 'passport' | 'national_identity_card' | 'driving_license' | 'citizen_card' | 'residence_permit' | 'electoral_id', required: The type of document used for identity verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `back` string: The ID of the back side of the document as represented within Checkout.com systems. - `certified_authorised_signatory` object: Required when the legal representative or other role owner is not registered on certificate of incorporation - `type` 'power_of_attorney', required: The type of document. - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `business_type` 'individual_or_sole_proprietorship' | 'private_corporation' | 'limited_liability_corporation' | 'publicly_traded_corporation' | 'limited_partnership' | 'non_profit_entity' | 'government_agency' | 'regulated_financial_institution' | 'sec_registered_entity' | 'cftc_registered_entity', required: The legal type of the company - `processing_details` object, required: Seller processing details. - `settlement_country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) where the settlement bank account is located - `target_countries` string[], required: Target country codes (iso-3166-1 alpha-2) with more than 10% expected volume processing with Checkout - `annual_processing_volume` integer, required: The estimated annual processing volume. In minor units without decimals. - `average_transaction_value` integer, required: The expected average transaction value. In minor units without decimals. - `highest_transaction_value` integer, required: The expected highest transaction value. In minor units without decimals. - `currency` 'USD', required: The currency used for the processing details provided. - `documents` object, required: The documents used to support the verification of company details. - `tax_verification` object: Employer Identification Number document. - `type` 'ein_letter', required: The type of document used for tax verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `company_verification` object: Certified by a power of attorney within the last 3 months - `type` 'incorporation_document', required: The type of document used for company verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `articles_of_association` object: Memorandum or Articles of Association document - `type` 'memorandum_of_association' | 'articles_of_association', required: The type of document used for company verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `bank_verification` object: A document showing transactions from the last 3 months, an official bank letter or a copy of a voided check. - `type` 'bank_statement' | 'bank_letter' | 'voided_check', required: The type of document being used as bank verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `shareholder_structure` object: Shareholder structure chart (including % of shares) certified by a competent authority individual and dated within last 3 months - `type` 'certified_shareholder_structure', required: The type of document. - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `proof_of_legality` object: A regulatory licence document required for the company to operate (when applicable) - `type` 'proof_of_legality', required: The type of document used for proof of legality - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `proof_of_principal_address` object: Proof of principal place of business - `type` 'proof_of_address', required: The type of document being used as address verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `additional_document1` object: Additional space for documents to be provided when requested - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `additional_document2` object: Additional space for documents to be provided when requested - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `additional_document3` object: Additional space for documents to be provided when requested - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - GBCompanyFull20 - `reference` string, required: A unique reference you can later use to identify the sub-entity. - `status` string - `is_draft` boolean: Specifies whether the sub-entity details are in draft. Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks. - `profile` object, required: Information about the profile of the sub-entity, primarily regarding the products/services offered. - `urls` string[], required: A collection of website URLs the sub-entity accepts payments on. - `mccs` unknown[], required: Select the categories that most closely describe the business - unknown - `default_holding_currency` unknown - `holding_currencies` string[]: Incoming funds are held in your selected currencies - `contact_details` object, required: Contact details of this sub-entity. - `phone` object, required: The phone number of the sub-entity. - `number` unknown, required - `email_addresses` object, required: Email addresses for this sub-entity. - `primary` unknown, required - `invitee` object: The details of the user responsible for onboarding the sub-entity. - `email` unknown - `capabilities` object: The capabilities of the entity. - `requirements_due` object[]: List of requirements due in order to be onboarded. - `field` string: The field that is needs to be addressed. - `reason` string: The reason behind the field needing attention. - `instruments` object[] - `company` object, required: Information about the company represented by the sub-entity. - `legal_name` string, required: The legal name of the sub-entity. - `trading_name` string, required: The trading name of the sub-entity, also referred to as 'doing business as'. - `business_registration_number` unknown, required - `principal_address` object, required: The primary location of the company where business is performed. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `registered_address` object, required: The registered address of the company. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `representatives` object[], required: Information about representatives of this company. - `id` unknown - `first_name` string, required: The representative's first name. - `middle_name` string: The representative's middle name. Required if appears in official docs - `last_name` string, required: The representative's last name. - `documents` object: A legal document used to verify identity - `identity_verification` object, required: The document to use to confirm the individual's identity. - `type` 'passport' | 'national_identity_card' | 'driving_license' | 'citizen_card' | 'residence_permit' | 'electoral_id', required: The type of document used for identity verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `back` string: The ID of the back side of the document as represented within Checkout.com systems. - `date_of_birth` object, required: The date of birth of the person according to the Gregorian calendar. - `day` integer, required: The calendar day of the month they were born. - `month` integer, required: The month of the year they were born. - `year` integer, required: The year they were born. - `phone` object: The phone number of the sub-entity. - `number` unknown, required - `address` object, required: The representative's address. - `address_line1` string: The first line of the address. - `address_line2` unknown - `city` string: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `roles` string[], required: The individual's roles within the company - `date_of_incorporation` object: The date the company was incorporated. - `day` integer: The day of the month the company was incorporated. - `month` integer, required: The month the company was incorporated. - `year` integer, required: The year the company was incorporated. - `documents` object: The documents used to support the verification of company details. - `company_verification` object, required: Certified by a power of attorney within the last 3 months - `type` 'incorporation_document', required: The type of document used for company verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - EEACompanyFull20 - `reference` string, required: A unique reference you can later use to identify the sub-entity. - `status` string - `is_draft` boolean: Specifies whether the sub-entity details are in draft. Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks. - `profile` object, required: Information about the profile of the sub-entity, primarily regarding the products/services offered. - `urls` string[], required: A collection of website URLs the sub-entity accepts payments on. - `mccs` unknown[], required: Select the categories that most closely describe the business - unknown - `default_holding_currency` unknown - `holding_currencies` string[]: Incoming funds are held in your selected currencies - `contact_details` object, required: Contact details of this sub-entity. - `phone` object, required: The phone number of the sub-entity. - `number` unknown, required - `email_addresses` object, required: Email addresses for this sub-entity. - `primary` unknown, required - `invitee` object: The details of the user responsible for onboarding the sub-entity. - `email` unknown - `capabilities` object: The capabilities of the entity. - `requirements_due` object[]: List of requirements due in order to be onboarded. - `field` string: The field that is needs to be addressed. - `reason` string: The reason behind the field needing attention. - `instruments` object[] - `company` object, required: Information about the company represented by the sub-entity. - `legal_name` string, required: The legal name of the sub-entity. - `trading_name` string, required: The trading name of the sub-entity, also referred to as 'doing business as'. - `business_registration_number` unknown, required - `principal_address` object, required: The primary location of the company where business is performed. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `registered_address` object, required: The registered address of the company. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `representatives` object[], required: Information about representatives of this company. - `id` unknown - `first_name` string, required: The representative's first name. - `middle_name` string: The representative's middle name. Required if appears in official docs - `last_name` string, required: The representative's last name. - `date_of_birth` object, required: The date of birth of the person according to the Gregorian calendar. - `day` integer, required: The calendar day of the month they were born. - `month` integer, required: The month of the year they were born. - `year` integer, required: The year they were born. - `phone` object: The phone number of the sub-entity. - `number` unknown, required - `address` object, required: The representative's address. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `place_of_birth` object, required: The place of birth of the person. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `roles` string[], required: The individual's roles within the company - `documents` object, required: A legal document used to verify identity - `identity_verification` object, required: The document to use to confirm the individual's identity. - `type` 'passport' | 'national_identity_card' | 'driving_license' | 'citizen_card' | 'residence_permit' | 'electoral_id', required: The type of document used for identity verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `back` string: The ID of the back side of the document as represented within Checkout.com systems. - `financial_details` object, required: Seller financial questions and supporting documents. - `annual_processing_volume` integer, required: The estimated annual processing volume. In minor units without decimals. - `average_transaction_value` integer, required: The expected average transaction value. In minor units without decimals. - `highest_transaction_value` integer, required: The expected highest transaction value. In minor units without decimals. - `currency` 'EUR': The currency used for the processing details provided. - `business_type` 'general_partnership' | 'limited_partnership' | 'public_limited_company' | 'limited_company' | 'professional_association' | 'unincorporated_association' | 'auto_entrepreneur', required: The legal type of the company - `date_of_incorporation` object: The date the company was incorporated. - `day` integer: The day of the month the company was incorporated. - `month` integer, required: The month the company was incorporated. - `year` integer, required: The year the company was incorporated. - `documents` object, required: The documents used to support the identity of a company. - `company_verification` object, required: Certified by a power of attorney within the last 3 months - `type` 'incorporation_document', required: The type of document used for company verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `bank_verification` object: A document showing transactions from the last 3 months or an official bank letter. - `type` 'bank_statement' | 'bank_letter', required: The type of document being used as bank verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `financial_verification` object: Financial statement document becomes mandatory depending on the answer provided for annual_processing_volume. The status of your sub-entity will change to requirements_due stating when this is necessary. - `type` 'financial_statement', required: The type of the file. - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - USCompanyFull20 - `reference` string, required: A unique reference you can later use to identify the sub-entity. - `status` string - `is_draft` boolean: Specifies whether the sub-entity details are in draft. Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks. - `profile` object, required: Information about the profile of the sub-entity, primarily regarding the products/services offered. - `urls` string[], required: A collection of website URLs the sub-entity accepts payments on. - `mccs` unknown[], required: Select the categories that most closely describe the business - unknown - `default_holding_currency` unknown - `holding_currencies` string[]: Incoming funds are held in your selected currencies - `contact_details` object, required - `phone` object, required - `number` unknown, required - `email_addresses` object, required - `primary` unknown, required - `invitee` object - `email` unknown - `capabilities` object: The capabilities of the entity. - `requirements_due` object[]: List of requirements due in order to be onboarded. - `field` string: The field that is needs to be addressed. - `reason` string: The reason behind the field needing attention. - `instruments` object[] - `company` object, required: Information about the company represented by the sub-entity. - `legal_name` string, required: The legal name of the sub-entity. - `trading_name` string, required: The trading name of the sub-entity, also referred to as 'doing business as'. - `business_registration_number` string, required: Employer Identification Number (EIN). - `principal_address` object, required: The primary location of the company where business is performed. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` 'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'AS' | 'GU' | 'MP' | 'PR' | 'VI' | 'UM', required: The address state. This field is required for addresses based in the US. For US addresses, provide the state as an ISO 3166-1 code. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `registered_address` object, required: The registered address of the company. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` 'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'AS' | 'GU' | 'MP' | 'PR' | 'VI' | 'UM', required: The address state. This field is required for addresses based in the US. For US addresses, provide the state as an ISO 3166-1 code. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `representatives` object[], required: Information about representatives of this company. - `id` unknown - `first_name` string, required: The representative's first name. - `middle_name` string: The representative's middle name. Required if appears in official docs - `last_name` string, required: The representative's last name. - `identification` object, required: Information about representatives of this company. - `national_id_number` unknown, required - `date_of_birth` object, required: The date of birth of the person according to the Gregorian calendar. - `day` integer, required: The calendar day of the month they were born. - `month` integer, required: The month of the year they were born. - `year` integer, required: The year they were born. - `phone` object: The phone number of the sub-entity. - `number` unknown, required - `address` object, required: The representative's address. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `documents` object: A legal document used to verify identity - `identity_verification` object, required: The document to use to confirm the individual's identity. - `type` 'passport' | 'national_identity_card' | 'driving_license' | 'citizen_card' | 'residence_permit' | 'electoral_id', required: The type of document used for identity verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `back` string: The ID of the back side of the document as represented within Checkout.com systems. - `roles` string[], required: The individual's roles within the company - `business_type` 'private_corporation' | 'publicly_traded_corporation' | 'government_agency' | 'individual_or_sole_proprietorship' | 'limited_liability_corporation' | 'limited_partnership' | 'non_profit_entity' | 'sec_registered_entity' | 'cftc_registered_entity' | 'regulated_financial_institution', required: The legal type of the company - `financial_details` object, required: Seller financial questions and supporting documents. - `annual_processing_volume` integer, required: The estimated annual processing volume. In minor units without decimals. - `average_transaction_value` integer, required: The expected average transaction value. In minor units without decimals. - `highest_transaction_value` integer, required: The expected highest transaction value. In minor units without decimals. - `currency` 'USD', required: The currency used for the processing details provided. - `date_of_incorporation` object: The date the company was incorporated. - `day` integer: The day of the month the company was incorporated. - `month` integer, required: The month the company was incorporated. - `year` integer, required: The year the company was incorporated. - `documents` object: The documents used to support the verification of company details. - `company_verification` object: The document to use to confirm the company's identity. - `type` 'incorporation_document' | 'articles_of_association', required: The type of document being used for company verification. - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `tax_verification` object: Employer Identification Number document. - `type` 'ein_letter', required: The type of document used for tax verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - GBCompanyLite20 - `reference` string, required: A unique reference you can later use to identify the sub-entity. - `status` string - `is_draft` boolean: Specifies whether the sub-entity details are in draft. Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks. - `profile` object, required: Information about the profile of the sub-entity, primarily regarding the products/services offered. - `urls` string[], required: A collection of website URLs the sub-entity accepts payments on. - `mccs` unknown[], required: Select the categories that most closely describe the business - unknown - `contact_details` object, required: Contact details of this sub-entity. - `phone` object, required: The phone number of the sub-entity. - `number` unknown, required - `email_addresses` object, required: Email addresses for this sub-entity. - `primary` unknown, required - `invitee` object: The details of the user responsible for onboarding the sub-entity. - `email` unknown - `capabilities` object: The capabilities of the entity. - `requirements_due` object[]: List of requirements due in order to be onboarded. - `field` string: The field that is needs to be addressed. - `reason` string: The reason behind the field needing attention. - `instruments` object[] - `company` object, required - `legal_name` string, required: The legal name of the sub-entity. - `trading_name` string, required: The trading name of the sub-entity, also referred to as 'doing business as'. - `business_registration_number` unknown - `principal_address` object, required: The primary location of the company where business is performed. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `registered_address` object, required: The registered address of the company. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `representatives` object[], required: Information about representatives of this company. - `id` unknown - `first_name` string, required: The representative's first name. - `middle_name` string: The representative's middle name. Required if appears in official docs - `last_name` string, required: The representative's last name. - `documents` object: A legal document used to verify identity - `identity_verification` object, required: The document to use to confirm the individual's identity. - `type` 'passport' | 'national_identity_card' | 'driving_license' | 'citizen_card' | 'residence_permit' | 'electoral_id', required: The type of document used for identity verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `back` string: The ID of the back side of the document as represented within Checkout.com systems. - `date_of_birth` object: The date of birth of the person according to the Gregorian calendar. - `day` integer, required: The calendar day of the month they were born. - `month` integer, required: The month of the year they were born. - `year` integer, required: The year they were born. - `phone` object: The phone number of the sub-entity. - `number` unknown, required - `address` object, required: The representative's address. - `address_line1` string: The first line of the address. - `address_line2` unknown - `city` string: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `roles` string[], required: The individual's roles within the company - `documents` object - `company_verification` object: Certified by a power of attorney within the last 3 months - `type` 'incorporation_document', required: The type of document used for company verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - EEACompanyLite20 - `reference` string, required: A unique reference you can later use to identify the sub-entity. - `status` string - `is_draft` boolean: Specifies whether the sub-entity details are in draft. Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks. - `profile` object, required: Information about the profile of the sub-entity, primarily regarding the products/services offered. - `urls` string[], required: A collection of website URLs the sub-entity accepts payments on. - `mccs` unknown[], required: Select the categories that most closely describe the business - unknown - `contact_details` object, required: Contact details of this sub-entity. - `phone` object, required: The phone number of the sub-entity. - `number` unknown, required - `email_addresses` object, required: Email addresses for this sub-entity. - `primary` unknown, required - `invitee` object: The details of the user responsible for onboarding the sub-entity. - `email` unknown - `capabilities` object: The capabilities of the entity. - `requirements_due` object[]: List of requirements due in order to be onboarded. - `field` string: The field that is needs to be addressed. - `reason` string: The reason behind the field needing attention. - `instruments` object[] - `company` object, required - `legal_name` string, required: The legal name of the sub-entity. - `trading_name` string, required: The trading name of the sub-entity, also referred to as 'doing business as'. - `business_registration_number` unknown - `principal_address` object, required: The primary location of the company where business is performed. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `registered_address` object, required: The registered address of the company. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `representatives` object[], required: Information about representatives of this company. - `id` unknown - `first_name` string, required: The representative's first name. - `middle_name` string: The representative's middle name. Required if appears in official docs - `last_name` string, required: The representative's last name. - `documents` object: A legal document used to verify identity - `identity_verification` object, required: The document to use to confirm the individual's identity. - `type` 'passport' | 'national_identity_card' | 'driving_license' | 'citizen_card' | 'residence_permit' | 'electoral_id', required: The type of document used for identity verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `back` string: The ID of the back side of the document as represented within Checkout.com systems. - `date_of_birth` object: The date of birth of the person according to the Gregorian calendar. - `day` integer, required: The calendar day of the month they were born. - `month` integer, required: The month of the year they were born. - `year` integer, required: The year they were born. - `phone` object: The phone number of the sub-entity. - `number` unknown, required - `address` object, required: The representative's address. - `address_line1` string: The first line of the address. - `address_line2` unknown - `city` string: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `place_of_birth` object: The place of birth of the person. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `roles` string[]: The individual's roles within the company - `financial_details` object: Seller financial questions and supporting documents. - `annual_processing_volume` integer: The estimated annual processing volume. In minor units without decimals. - `average_transaction_value` integer: The expected average transaction value. In minor units without decimals. - `highest_transaction_value` integer: The expected highest transaction value. In minor units without decimals. - `currency` 'EUR': The currency used for the processing details provided. - `business_type` 'general_partnership' | 'limited_partnership' | 'public_limited_company' | 'limited_company' | 'professional_association' | 'unincorporated_association' | 'auto_entrepreneur': The legal type of the company - `documents` object: The documents used to support the identity of a company. - `company_verification` object: Certified by a power of attorney within the last 3 months - `type` 'incorporation_document', required: The type of document used for company verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `bank_verification` object: A document showing transactions from last 3 months - `type` 'bank_statement', required: The type of document being used as bank verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `financial_verification` object: Financial statement document becomes mandatory depending on the answer provided for annual_processing_volume. The status of your sub-entity will change to requirements_due stating when this is necessary. - `type` 'financial_statement', required: The type of the file. - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - USCompanyLite20 - `reference` string, required: A unique reference you can later use to identify the sub-entity. - `status` string - `is_draft` boolean: Specifies whether the sub-entity details are in draft. Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks. - `profile` object, required: Information about the profile of the sub-entity, primarily regarding the products/services offered. - `urls` string[], required: A collection of website URLs the sub-entity accepts payments on. - `mccs` unknown[], required: Select the categories that most closely describe the business - unknown - `contact_details` object, required - `phone` object, required - `number` unknown, required - `email_addresses` object, required - `primary` unknown, required - `invitee` object - `email` unknown - `capabilities` object: The capabilities of the entity. - `requirements_due` object[]: List of requirements due in order to be onboarded. - `field` string: The field that is needs to be addressed. - `reason` string: The reason behind the field needing attention. - `instruments` object[] - `company` object, required: Information about the company represented by the sub-entity. - `legal_name` string, required: The legal name of the sub-entity. - `trading_name` string, required: The trading name of the sub-entity, also referred to as 'doing business as'. - `business_registration_number` string: Employer Identification Number (EIN). - `principal_address` object, required: The primary location of the company where business is performed. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` 'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'AS' | 'GU' | 'MP' | 'PR' | 'VI' | 'UM', required: The address state. This field is required for addresses based in the US. For US addresses, provide the state as an ISO 3166-1 code. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `registered_address` object, required: The registered address of the company. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` 'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'AS' | 'GU' | 'MP' | 'PR' | 'VI' | 'UM', required: The address state. This field is required for addresses based in the US. For US addresses, provide the state as an ISO 3166-1 code. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `representatives` object[], required: Information about representatives of this company. - `first_name` string, required: The representative's first name. - `middle_name` string: The representative's middle name. Required if appears in official docs - `last_name` string, required: The representative's last name. - `identification` object: Information about representatives of this company. - `national_id_number` unknown, required - `date_of_birth` object: The date of birth of the person according to the Gregorian calendar. - `day` integer, required: The calendar day of the month they were born. - `month` integer, required: The month of the year they were born. - `year` integer, required: The year they were born. - `phone` object: The phone number of the sub-entity. - `number` unknown, required - `address` object, required: The representative's address. - `address_line1` string: The first line of the address. - `address_line2` unknown - `city` string: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `documents` object: A legal document used to verify identity - `identity_verification` object, required: The document to use to confirm the individual's identity. - `type` 'passport' | 'national_identity_card' | 'driving_license' | 'citizen_card' | 'residence_permit' | 'electoral_id', required: The type of document used for identity verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `back` string: The ID of the back side of the document as represented within Checkout.com systems. - `roles` string[]: The individual's roles within the company - `business_type` 'private_corporation' | 'publicly_traded_corporation' | 'government_agency' | 'individual_or_sole_proprietorship' | 'limited_liability_corporation' | 'limited_partnership' | 'non_profit_entity' | 'sec_registered_entity' | 'cftc_registered_entity' | 'regulated_financial_institution': The legal type of the company - `financial_details` object: Seller financial questions and supporting documents. - `annual_processing_volume` integer: The estimated annual processing volume. In minor units without decimals. - `average_transaction_value` integer: The expected average transaction value. In minor units without decimals. - `highest_transaction_value` integer: The expected highest transaction value. In minor units without decimals. - `currency` 'USD': The currency used for the processing details provided. - `documents` object: The documents used to support the verification of company details. - `company_verification` object: The document to use to confirm the company's identity. - `type` 'incorporation_document' | 'articles_of_association', required: The type of document being used for company verification. - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `tax_verification` object: Employer Identification Number document. - `type` 'ein_letter', required: The type of document used for tax verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - GBSoleTraderFull30 - `reference` string, required: A unique reference you can later use to identify the sub-entity. - `status` string - `is_draft` boolean: Specifies whether the sub-entity details are in draft. Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks. - `profile` object, required: Information about the profile of the sub-entity, primarily regarding the products/services offered. - `urls` string[], required: A collection of website URLs the sub-entity accepts payments on. - `mccs` unknown[], required: Select the categories that most closely describe the business - unknown - `default_holding_currency` unknown, required - `holding_currencies` string[], required: Incoming funds are held in your selected currencies - `contact_details` object, required: Contact details of this sub-entity. - `phone` object: Phone number - `country_code` 'GI' | 'CH' | 'GG' | 'IM' | 'JE' | 'GB', required: The country code (iso-3166-1 alpha-2) where the phone number is registered - `number` string, required: The phone number without the country calling code - `email_addresses` object: Email addresses for this sub-entity. - `primary` unknown, required - `invitee` object: The details of the user responsible for onboarding the sub-entity. - `email` unknown - `capabilities` object: The capabilities of the entity. - `requirements_due` object[]: List of requirements due in order to be onboarded. - `field` string: The field that is needs to be addressed. - `reason` string: The reason behind the field needing attention. - `message` string: A more descriptive message. - `company` object, required: Information about the sole trader's business. - `trading_name` string, required: The trading name of the sub-entity, also referred to as 'doing business as'. - `date_of_incorporation` object, required: The date the company was incorporated. - `day` integer: The day of the month the company was incorporated. - `month` integer, required: The month the company was incorporated. - `year` integer, required: The year the company was incorporated. - `principal_address` object, required: The primary location where business is performed. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `representatives` object[], required: Information about representatives of this company. - `id` unknown - `individual` object, required: Information about the individual representing the sub-entity. - `first_name` string, required: The representative's first name. - `middle_name` string: The representative's middle name. Required if appears in official docs - `last_name` string, required: The representative's last name. - `date_of_birth` object, required: The date of birth of the person according to the Gregorian calendar. - `day` integer, required: The calendar day of the month they were born. - `month` integer, required: The month of the year they were born. - `year` integer, required: The year they were born. - `place_of_birth` object, required: The place of birth of the person. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `national_id_number` unknown - `email_address` unknown - `phone` object: Phone number - `country_code` 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BR' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CO' | 'KM' | 'CD' | 'CG' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'BQ' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UY' | 'UZ' | 'VU' | 'VA' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW', required: The country code (iso-3166-1 alpha-2) where the phone number is registered - `number` string, required: The phone number without the country calling code - `address` object, required: The representative's address. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `roles` string[], required: The individual's roles within the company - `documents` object, required: Verification documents for the individual representative - `identity_verification` object, required: The document to use to confirm the individual's identity. - `type` 'passport' | 'national_identity_card' | 'driving_license' | 'citizen_card' | 'residence_permit' | 'electoral_id', required: The type of document used for identity verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `back` string: The ID of the back side of the document as represented within Checkout.com systems. - `business_type` 'individual_or_sole_proprietorship' | 'limited_company' | 'public_limited_company' | 'limited_partnership' | 'general_partnership' | 'scottish_limited_partnership' | 'government_agency' | 'non_profit_entity' | 'trust' | 'club_or_society' | 'unincorporated_association', required: The legal type of the company - `processing_details` object, required: Seller processing details. - `settlement_country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) where the settlement bank account is located - `target_countries` string[], required: Target country codes (iso-3166-1 alpha-2) with more than 10% expected volume processing with Checkout - `annual_processing_volume` integer, required: The estimated annual processing volume. In minor units without decimals. - `average_transaction_value` integer, required: The expected average transaction value. In minor units without decimals. - `highest_transaction_value` integer, required: The expected highest transaction value. In minor units without decimals. - `currency` 'GBP', required: The currency used for the processing details provided. - `documents` object, required: The documents used to support the verification of business details. - `bank_verification` object, required: A document showing transactions from the last 3 months or an official bank letter. - `type` 'bank_statement' | 'bank_letter', required: The type of document being used as bank verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `additional_document1` object: Additional space for documents to be provided when requested - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `additional_document2` object: Additional space for documents to be provided when requested - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `additional_document3` object: Additional space for documents to be provided when requested - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - EEASoleTraderFull30 - `reference` string, required: A unique reference you can later use to identify the sub-entity. - `status` string - `is_draft` boolean: Specifies whether the sub-entity details are in draft. Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks. - `profile` object, required: Information about the profile of the sub-entity, primarily regarding the products/services offered. - `urls` string[], required: A collection of website URLs the sub-entity accepts payments on. - `mccs` unknown[], required: Select the categories that most closely describe the business - unknown - `default_holding_currency` unknown, required - `holding_currencies` string[], required: Incoming funds are held in your selected currencies - `contact_details` object, required: Contact details of this sub-entity. - `phone` object: Phone number - `country_code` 'GR' | 'NL' | 'BE' | 'FR' | 'ES' | 'PT' | 'LU' | 'IE' | 'IS' | 'MT' | 'CY' | 'FI' | 'BG' | 'HU' | 'LT' | 'LV' | 'EE' | 'AD' | 'HR' | 'SI' | 'IT' | 'RO' | 'CZ' | 'SK' | 'LI' | 'AT' | 'DK' | 'SE' | 'NO' | 'PL' | 'DE', required: The country code (iso-3166-1 alpha-2) where the phone number is registered - `number` string, required: The phone number without the country calling code - `email_addresses` object: Email addresses for this sub-entity. - `primary` unknown, required - `invitee` object: The details of the user responsible for onboarding the sub-entity. - `email` unknown - `capabilities` object: The capabilities of the entity. - `requirements_due` object[]: List of requirements due in order to be onboarded. - `field` string: The field that is needs to be addressed. - `reason` string: The reason behind the field needing attention. - `message` string: A more descriptive message. - `company` object, required: Information about the sole trader's business. - `trading_name` string, required: The trading name of the sub-entity, also referred to as 'doing business as'. - `is_registered_company` boolean: Specifies if the sole trader is registered as a business. If `true`, you must provide `business_registration_number`. - `business_registration_number` string: The sole trader's business registration number, without spaces or separators. Required if `is_registered_company` is `true`. If the sole trader's principal address is in one of these countries, the number must use that country's format: - Belgium: The 10-digit enterprise number, which starts with `0` or `1`. - France: The 14-digit SIRET number. - Luxembourg: The 11- or 13-digit national identification number (matricule), not the RCS number. - `date_of_incorporation` object, required: The date the company was incorporated. - `day` integer: The day of the month the company was incorporated. - `month` integer, required: The month the company was incorporated. - `year` integer, required: The year the company was incorporated. - `principal_address` object, required: The primary location where business is performed. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `representatives` object[], required: Information about representatives of this company. - `id` unknown - `individual` object, required: Information about the individual representing the sub-entity. - `first_name` string, required: The representative's first name. - `middle_name` string: The representative's middle name. Required if appears in official docs - `last_name` string, required: The representative's last name. - `date_of_birth` object, required: The date of birth of the person according to the Gregorian calendar. - `day` integer, required: The calendar day of the month they were born. - `month` integer, required: The month of the year they were born. - `year` integer, required: The year they were born. - `place_of_birth` object, required: The place of birth of the person. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `national_id_number` unknown - `email_address` unknown - `phone` object: Phone number - `country_code` 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BR' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CO' | 'KM' | 'CD' | 'CG' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'BQ' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UY' | 'UZ' | 'VU' | 'VA' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW', required: The country code (iso-3166-1 alpha-2) where the phone number is registered - `number` string, required: The phone number without the country calling code - `address` object, required: The representative's address. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `roles` string[], required: The individual's roles within the company - `documents` object, required: Verification documents for the individual representative - `identity_verification` object, required: The document to use to confirm the individual's identity. - `type` 'passport' | 'national_identity_card' | 'driving_license' | 'citizen_card' | 'residence_permit' | 'electoral_id', required: The type of document used for identity verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `back` string: The ID of the back side of the document as represented within Checkout.com systems. - `proof_of_residential_address` object, required: Proof of residential address of the representative - `type` 'proof_of_address', required: The type of document being used as address verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `proof_of_registration` object, required: Proof of sole traders registration e.g. extract from a trade register - `type` 'extract_from_trade_register' | 'other', required: The type of document being used as proof of registration - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `business_type` 'individual_or_sole_proprietorship' | 'limited_company' | 'public_limited_company' | 'limited_partnership' | 'general_partnership' | 'government_agency' | 'non_profit_entity' | 'trust' | 'club_or_society' | 'unincorporated_association', required: The legal type of the company - `processing_details` object, required - `settlement_country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) where the settlement bank account is located - `target_countries` string[], required: Target country codes (iso-3166-1 alpha-2) with more than 10% expected volume processing with Checkout - `annual_processing_volume` integer, required: The estimated annual processing volume. In minor units without decimals. - `average_transaction_value` integer, required: The expected average transaction value. In minor units without decimals. - `highest_transaction_value` integer, required: The expected highest transaction value. In minor units without decimals. - `currency` 'EUR', required: The currency used for the processing details provided. - `documents` object, required: The documents used to support the verification of business details. - `bank_verification` object, required: A document showing transactions from the last 3 months or an official bank letter. - `type` 'bank_statement' | 'bank_letter', required: The type of document being used as bank verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `additional_document1` object: Additional space for documents to be provided when requested - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `additional_document2` object: Additional space for documents to be provided when requested - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `additional_document3` object: Additional space for documents to be provided when requested - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - USSoleTraderFull30 - `reference` string, required: A unique reference you can later use to identify the sub-entity. - `status` string - `is_draft` boolean: Specifies whether the sub-entity details are in draft. Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks. - `profile` object, required: Information about the profile of the sub-entity, primarily regarding the products/services offered. - `urls` string[], required: A collection of website URLs the sub-entity accepts payments on. - `mccs` unknown[], required: Select the categories that most closely describe the business - unknown - `default_holding_currency` unknown, required - `holding_currencies` string[], required: Incoming funds are held in your selected currencies - `contact_details` object, required: Contact details of this sub-entity. - `phone` object: Phone number - `country_code` 'US', required: The country code (iso-3166-1 alpha-2) where the phone number is registered - `number` string, required: The phone number without the country calling code - `email_addresses` object: Email addresses for this sub-entity. - `primary` unknown, required - `invitee` object: The details of the user responsible for onboarding the sub-entity. - `email` unknown - `capabilities` object: The capabilities of the entity. - `requirements_due` object[]: List of requirements due in order to be onboarded. - `field` string: The field that is needs to be addressed. - `reason` string: The reason behind the field needing attention. - `message` string: A more descriptive message. - `company` object, required: Information about the company represented by the sub-entity. - `trading_name` string, required: The trading name of the sub-entity, also referred to as 'doing business as'. - `date_of_incorporation` object, required: The date the company was incorporated. - `day` integer: The day of the month the company was incorporated. - `month` integer, required: The month the company was incorporated. - `year` integer, required: The year the company was incorporated. - `principal_address` object, required: The primary location where business is performed. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` 'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'AS' | 'GU' | 'MP' | 'PR' | 'VI' | 'UM', required: The address state. This field is required for addresses based in the US. For US addresses, provide the state as an ISO 3166-1 code. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `representatives` object[], required: Information about representatives of this company. - `id` unknown - `individual` object, required: Information about the individual representing the sub-entity. - `first_name` string, required: The representative's first name. - `middle_name` string: The representative's middle name. Required if appears in official docs - `last_name` string, required: The representative's last name. - `date_of_birth` object, required: The date of birth of the person according to the Gregorian calendar. - `day` integer, required: The calendar day of the month they were born. - `month` integer, required: The month of the year they were born. - `year` integer, required: The year they were born. - `place_of_birth` object, required: The place of birth of the person. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `national_id_number` unknown - `email_address` unknown - `phone` object: Phone number - `country_code` 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BR' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CO' | 'KM' | 'CD' | 'CG' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'BQ' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UY' | 'UZ' | 'VU' | 'VA' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW', required: The country code (iso-3166-1 alpha-2) where the phone number is registered - `number` string, required: The phone number without the country calling code - `address` object, required: The representative's address. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `roles` string[], required: The individual's roles within the company - `documents` object, required: Verification documents for the individual representative - `identity_verification` object, required: The document to use to confirm the individual's identity. - `type` 'passport' | 'national_identity_card' | 'driving_license' | 'citizen_card' | 'residence_permit' | 'electoral_id', required: The type of document used for identity verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `back` string: The ID of the back side of the document as represented within Checkout.com systems. - `business_type` 'individual_or_sole_proprietorship' | 'private_corporation' | 'limited_liability_corporation' | 'publicly_traded_corporation' | 'limited_partnership' | 'non_profit_entity' | 'government_agency' | 'regulated_financial_institution' | 'sec_registered_entity' | 'cftc_registered_entity', required: The legal type of the company - `processing_details` object, required: Seller processing details. - `settlement_country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) where the settlement bank account is located - `target_countries` string[], required: Target country codes (iso-3166-1 alpha-2) with more than 10% expected volume processing with Checkout - `annual_processing_volume` integer, required: The estimated annual processing volume. In minor units without decimals. - `average_transaction_value` integer, required: The expected average transaction value. In minor units without decimals. - `highest_transaction_value` integer, required: The expected highest transaction value. In minor units without decimals. - `currency` 'USD', required: The currency used for the processing details provided. - `documents` object, required: The documents used to support the verification of business details. - `bank_verification` object, required: A document showing transactions from the last 3 months, an official bank letter or a copy of a voided check. - `type` 'bank_statement' | 'bank_letter' | 'voided_check', required: The type of document being used as bank verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `additional_document1` object: Additional space for documents to be provided when requested - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `additional_document2` object: Additional space for documents to be provided when requested - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `additional_document3` object: Additional space for documents to be provided when requested - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - GBSoleTraderFull20 - `reference` string, required: A unique reference you can later use to identify the sub-entity. - `status` string - `is_draft` boolean: Specifies whether the sub-entity details are in draft. Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks. - `profile` object, required: Information about the profile of the sub-entity, primarily regarding the products/services offered. - `urls` string[], required: A collection of website URLs the sub-entity accepts payments on. - `mccs` unknown[], required: Select the categories that most closely describe the business - unknown - `default_holding_currency` unknown - `holding_currencies` string[]: Incoming funds are held in your selected currencies - `contact_details` object, required: Contact details of this sub-entity. - `phone` object, required: The phone number of the sub-entity. - `number` unknown, required - `email_addresses` object, required: Email addresses for this sub-entity. - `primary` unknown, required - `invitee` object: The details of the user responsible for onboarding the sub-entity. - `email` unknown - `capabilities` object: The capabilities of the entity. - `requirements_due` object[]: List of requirements due in order to be onboarded. - `field` string: The field that is needs to be addressed. - `reason` string: The reason behind the field needing attention. - `instruments` object[] - `individual` object, required: Information about the individual represented by the sub-entity. - `trading_name` string, required: The trading name of the sub-entity, also referred to as 'doing business as'. - `first_name` string, required: The representative's first name. - `middle_name` string: The representative's middle name. Required if appears in official docs - `last_name` string, required: The representative's last name. - `date_of_birth` object, required: The date of birth of the person according to the Gregorian calendar. - `day` integer, required: The calendar day of the month they were born. - `month` integer, required: The month of the year they were born. - `year` integer, required: The year they were born. - `registered_address` object, required: The registered address of the company. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `documents` object: A legal document used to verify identity. - `identity_verification` object, required: The document to use to confirm the individual's identity. - `type` 'passport' | 'national_identity_card' | 'driving_license' | 'citizen_card' | 'residence_permit' | 'electoral_id', required: The type of document used for identity verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `back` string: The ID of the back side of the document as represented within Checkout.com systems. - EEASoleTraderFull20 - `reference` string, required: A unique reference you can later use to identify the sub-entity. - `status` string - `is_draft` boolean: Specifies whether the sub-entity details are in draft. Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks. - `profile` object, required: Information about the profile of the sub-entity, primarily regarding the products/services offered. - `urls` string[], required: A collection of website URLs the sub-entity accepts payments on. - `mccs` unknown[], required: Select the categories that most closely describe the business - unknown - `default_holding_currency` unknown - `holding_currencies` string[]: Incoming funds are held in your selected currencies - `contact_details` object, required: Contact details of this sub-entity. - `phone` object, required: The phone number of the sub-entity. - `number` unknown, required - `email_addresses` object, required: Email addresses for this sub-entity. - `primary` unknown, required - `invitee` object: The details of the user responsible for onboarding the sub-entity. - `email` unknown - `capabilities` object: The capabilities of the entity. - `requirements_due` object[]: List of requirements due in order to be onboarded. - `field` string: The field that is needs to be addressed. - `reason` string: The reason behind the field needing attention. - `instruments` object[] - `individual` object, required: Information about the individual represented by the sub-entity. - `trading_name` string, required: The trading name of the sub-entity, also referred to as 'doing business as'. - `is_registered_company` boolean: Specifies if the sole trader is registered as a business. The value you specify determines the identification number you must provide in the request: - If `true`, provide `business_registration_number`. - If `false`, provide `national_tax_id`. - `business_registration_number` string: The sole trader's business registration number, without spaces or separators. Only provide this value if you set `is_registered_company` to `true`. Sole traders based in certain countries must provide a specific value: - Belgium: The 10-digit enterprise number, which starts with `0` or `1`. - France: The 14-digit SIRET number. - Luxembourg: The 11- or 13-digit national identification number (matricule), not the RCS number. - `national_tax_id` string: The sole trader's tax identification number, without spaces or separators. Don't provide this value if you set `is_registered_company` to `true`. If you set `is_registered_company` to `false` and the sole trader is based in Belgium, France, or Luxembourg, the number must use the same format as `business_registration_number` for that country. - `first_name` string, required: The representative's first name. - `middle_name` string: The representative's middle name. Required if appears in official docs - `last_name` string, required: The representative's last name. - `date_of_birth` object, required: The date of birth of the person according to the Gregorian calendar. - `day` integer, required: The calendar day of the month they were born. - `month` integer, required: The month of the year they were born. - `year` integer, required: The year they were born. - `registered_address` object, required: The registered address of the company. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `place_of_birth` object, required: The place of birth of the person. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `documents` object, required: A legal document used to verify identity. - `identity_verification` object, required: The document to use to confirm the individual's identity. - `type` 'passport' | 'national_identity_card' | 'driving_license' | 'citizen_card' | 'residence_permit' | 'electoral_id', required: The type of document used for identity verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `back` string: The ID of the back side of the document as represented within Checkout.com systems. - USSoleTraderFull20 - `reference` string, required: A unique reference you can later use to identify the sub-entity. - `status` string - `is_draft` boolean: Specifies whether the sub-entity details are in draft. Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks. - `profile` object, required: Information about the profile of the sub-entity, primarily regarding the products/services offered. - `urls` string[], required: A collection of website URLs the sub-entity accepts payments on. - `mccs` unknown[], required: Select the categories that most closely describe the business - unknown - `default_holding_currency` unknown - `holding_currencies` string[]: Incoming funds are held in your selected currencies - `contact_details` object, required - `phone` object, required - `number` unknown, required - `email_addresses` object, required - `primary` unknown, required - `invitee` object - `email` unknown - `capabilities` object: The capabilities of the entity. - `requirements_due` object[]: List of requirements due in order to be onboarded. - `field` string: The field that is needs to be addressed. - `reason` string: The reason behind the field needing attention. - `instruments` object[] - `documents` object: A legal document used to verify identity. - `identity_verification` object, required: The document to use to confirm the individual's identity. - `type` 'passport' | 'national_identity_card' | 'driving_license' | 'citizen_card' | 'residence_permit' | 'electoral_id', required: The type of document used for identity verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `back` string: The ID of the back side of the document as represented within Checkout.com systems. - `individual` object, required: Information about the individual represented by the sub-entity. - `trading_name` string, required: The trading name of the sub-entity, also referred to as 'doing business as'. - `first_name` string, required: The representative's first name. - `middle_name` string: The representative's middle name. Required if appears in official docs - `last_name` string, required: The representative's last name. - `date_of_birth` object, required: The date of birth of the person according to the Gregorian calendar. - `day` integer, required: The calendar day of the month they were born. - `month` integer, required: The month of the year they were born. - `year` integer, required: The year they were born. - `registered_address` object, required: The registered address of the company. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` 'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'AS' | 'GU' | 'MP' | 'PR' | 'VI' | 'UM', required: The address state. This field is required for addresses based in the US. For US addresses, provide the state as an ISO 3166-1 code. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `identification` object, required: Information about representatives of this company. - `national_id_number` unknown, required - `financial_details` object, required: Seller financial questions and supporting documents. - `annual_processing_volume` integer, required: The estimated annual processing volume. In minor units without decimals. - `average_transaction_value` integer, required: The expected average transaction value. In minor units without decimals. - `highest_transaction_value` integer, required: The expected highest transaction value. In minor units without decimals. - `currency` 'USD', required: The currency used for the processing details provided. - GBSoleTraderLite20 - `reference` string, required: A unique reference you can later use to identify the sub-entity. - `status` string - `is_draft` boolean: Specifies whether the sub-entity details are in draft. Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks. - `profile` object, required: Information about the profile of the sub-entity, primarily regarding the products/services offered. - `urls` string[], required: A collection of website URLs the sub-entity accepts payments on. - `mccs` unknown[], required: Select the categories that most closely describe the business - unknown - `contact_details` object, required: Contact details of this sub-entity. - `phone` object, required: The phone number of the sub-entity. - `number` unknown, required - `email_addresses` object, required: Email addresses for this sub-entity. - `primary` unknown, required - `invitee` object: The details of the user responsible for onboarding the sub-entity. - `email` unknown - `capabilities` object: The capabilities of the entity. - `requirements_due` object[]: List of requirements due in order to be onboarded. - `field` string: The field that is needs to be addressed. - `reason` string: The reason behind the field needing attention. - `instruments` object[] - `documents` object: A legal document used to verify identity. - `identity_verification` object, required: The document to use to confirm the individual's identity. - `type` 'passport' | 'national_identity_card' | 'driving_license' | 'citizen_card' | 'residence_permit' | 'electoral_id', required: The type of document used for identity verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `back` string: The ID of the back side of the document as represented within Checkout.com systems. - `individual` object, required: Information about the individual represented by the sub-entity. - `trading_name` string, required: The trading name of the sub-entity, also referred to as 'doing business as'. - `first_name` string, required: The representative's first name. - `middle_name` string: The representative's middle name. Required if appears in official docs - `last_name` string, required: The representative's last name. - `date_of_birth` object: The date of birth of the person according to the Gregorian calendar. - `day` integer, required: The calendar day of the month they were born. - `month` integer, required: The month of the year they were born. - `year` integer, required: The year they were born. - `registered_address` object, required: The registered address of the company. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - EEASoleTraderLite20 - `reference` string, required: A unique reference you can later use to identify the sub-entity. - `status` string - `is_draft` boolean: Specifies whether the sub-entity details are in draft. Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks. - `profile` object, required: Information about the profile of the sub-entity, primarily regarding the products/services offered. - `urls` string[], required: A collection of website URLs the sub-entity accepts payments on. - `mccs` unknown[], required: Select the categories that most closely describe the business - unknown - `contact_details` object, required: Contact details of this sub-entity. - `phone` object, required: The phone number of the sub-entity. - `number` unknown, required - `email_addresses` object, required: Email addresses for this sub-entity. - `primary` unknown, required - `invitee` object: The details of the user responsible for onboarding the sub-entity. - `email` unknown - `capabilities` object: The capabilities of the entity. - `requirements_due` object[]: List of requirements due in order to be onboarded. - `field` string: The field that is needs to be addressed. - `reason` string: The reason behind the field needing attention. - `instruments` object[] - `documents` object: A legal document used to verify identity. - `identity_verification` object, required: The document to use to confirm the individual's identity. - `type` 'passport' | 'national_identity_card' | 'driving_license' | 'citizen_card' | 'residence_permit' | 'electoral_id', required: The type of document used for identity verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `back` string: The ID of the back side of the document as represented within Checkout.com systems. - `individual` object, required: Information about the individual represented by the sub-entity. - `trading_name` string, required: The trading name of the sub-entity, also referred to as 'doing business as'. - `is_registered_company` boolean: Specifies if the sole trader is registered as a business. The value you specify determines the identification number you must provide in the request: - If `true`, provide `business_registration_number`. - If `false`, provide `national_tax_id`. - `business_registration_number` string: The sole trader's business registration number, without spaces or separators. Only provide this value if you set `is_registered_company` to `true`. Sole traders based in certain countries must provide a specific value: - Belgium: The 10-digit enterprise number, which starts with `0` or `1`. - France: The 14-digit SIRET number. - Luxembourg: The 11- or 13-digit national identification number (matricule), not the RCS number. - `national_tax_id` string: The sole trader's tax identification number, without spaces or separators. Don't provide this value if you set `is_registered_company` to `true`. If you set `is_registered_company` to `false` and the sole trader is based in Belgium, France, or Luxembourg, the number must use the same format as `business_registration_number` for that country. - `first_name` string, required: The representative's first name. - `middle_name` string: The representative's middle name. Required if appears in official docs - `last_name` string, required: The representative's last name. - `registered_address` object, required: The registered address of the company. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` string: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `date_of_birth` object, required: The date of birth of the person according to the Gregorian calendar. - `day` integer, required: The calendar day of the month they were born. - `month` integer, required: The month of the year they were born. - `year` integer, required: The year they were born. - `place_of_birth` object, required: The place of birth of the person. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - USSoleTraderLite20 - `reference` string, required: A unique reference you can later use to identify the sub-entity. - `status` string - `is_draft` boolean: Specifies whether the sub-entity details are in draft. Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks. - `profile` object, required: Information about the profile of the sub-entity, primarily regarding the products/services offered. - `urls` string[], required: A collection of website URLs the sub-entity accepts payments on. - `mccs` unknown[], required: Select the categories that most closely describe the business - unknown - `contact_details` object, required - `phone` object, required - `number` unknown, required - `email_addresses` object, required - `primary` unknown, required - `invitee` object - `email` unknown - `capabilities` object: The capabilities of the entity. - `requirements_due` object[]: List of requirements due in order to be onboarded. - `field` string: The field that is needs to be addressed. - `reason` string: The reason behind the field needing attention. - `instruments` object[] - `documents` object: A legal document used to verify identity. - `identity_verification` object, required: The document to use to confirm the individual's identity. - `type` 'passport' | 'national_identity_card' | 'driving_license' | 'citizen_card' | 'residence_permit' | 'electoral_id', required: The type of document used for identity verification - `front` string, required: The ID of the front side of the document as represented within Checkout.com systems. - `back` string: The ID of the back side of the document as represented within Checkout.com systems. - `individual` object, required: Information about the individual represented by the sub-entity. - `trading_name` string, required: The trading name of the sub-entity, also referred to as 'doing business as'. - `first_name` string, required: The representative's first name. - `middle_name` string: The representative's middle name. Required if appears in official docs - `last_name` string, required: The representative's last name. - `date_of_birth` object, required: The date of birth of the person according to the Gregorian calendar. - `day` integer, required: The calendar day of the month they were born. - `month` integer, required: The month of the year they were born. - `year` integer, required: The year they were born. - `registered_address` object, required: The registered address of the company. - `address_line1` string, required: The first line of the address. - `address_line2` unknown - `city` string, required: The address city. - `state` 'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'OH' | 'OK' | 'OR' | 'PA' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY' | 'AS' | 'GU' | 'MP' | 'PR' | 'VI' | 'UM', required: The address state. This field is required for addresses based in the US. For US addresses, provide the state as an ISO 3166-1 code. - `zip` string, required: The address zip/postal code. - `country` string, iso-3166-1-alpha-2, required: The country code (iso-3166-1 alpha-2) - `identification` object: Information about representatives of this company. - `national_id_number` unknown, required - `financial_details` object: Seller financial questions and supporting documents. - `annual_processing_volume` integer: The estimated annual processing volume. In minor units without decimals. - `average_transaction_value` integer: The expected average transaction value. In minor units without decimals. - `highest_transaction_value` integer: The expected highest transaction value. In minor units without decimals. - `currency` 'USD': The currency used for the processing details provided. ## Other responses - `401`: Unauthorized - `404`: Entity not found - `422`: Invalid data was sent --- [API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)