BatchDeleteTaxRegistration

$result = $client->batchDeleteTaxRegistration([/* ... */]);
$promise = $client->batchDeleteTaxRegistrationAsync([/* ... */]);

Deletes tax registration for multiple accounts in batch. This can be used to delete tax registrations for up to five accounts in one batch.

Parameter Syntax

$result = $client->batchDeleteTaxRegistration([
    'accountIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'accountId' => '<string>',
            'code' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The exception when the input doesn't pass validation for at least one of the input parameters.

ConflictException:

The exception when the input is creating conflict with the given state.

InternalServerException:

The exception thrown when an unexpected error occurs when processing a request.

BatchPutTaxRegistration

$result = $client->batchPutTaxRegistration([/* ... */]);
$promise = $client->batchPutTaxRegistrationAsync([/* ... */]);

Adds or updates tax registration for multiple accounts in batch. This can be used to add or update tax registrations for up to five accounts in one batch. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first.

To call this API operation for specific countries, see the following country-specific requirements.

Bangladesh

• You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

Brazil

• You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation.

• For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address.

Georgia

• The valid personType values are Physical Person and Business.

Kenya

• You must specify the personType in the kenyaAdditionalInfo field of the additionalTaxInformation object.

• If the personType is Physical Person, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

Malaysia

• If you use this operation to set a tax registration number (TRN) in Malaysia, only resellers with a valid sales and service tax (SST) number are required to provide tax registration information.

• By using this API operation to set a TRN in Malaysia, Amazon Web Services will regard you as self-declaring that you're an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD) and have a valid SST number.

• Amazon Web Services reserves the right to seek additional information and/or take other actions to support your self-declaration as appropriate.

• If you're not a reseller of Amazon Web Services, we don't recommend that you use this operation to set the TRN in Malaysia.

• Only use this API operation to upload the TRNs for accounts through which you're reselling Amazon Web Services.

• Amazon Web Services is currently registered under the following service tax codes. You must include at least one of the service tax codes in the service tax code strings to declare yourself as an authorized registered business reseller.

  Taxable service and service tax codes:

  Consultancy - 9907061674

  Training or coaching service - 9907071685

  IT service - 9907101676

  Digital services and electronic medium - 9907121690

Nepal

• The sector valid values are Business and Individual.

Saudi Arabia

• For address, you must specify addressLine3.

South Korea

• You must specify the certifiedEmailId and legalName in the TaxRegistrationEntry object. Use Korean characters for legalName.

• You must specify the businessRepresentativeName, itemOfBusiness, and lineOfBusiness in the southKoreaAdditionalInfo field of the additionalTaxInformation object. Use Korean characters for these fields.

• You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

• For the address object, use Korean characters for addressLine1, addressLine2 city, postalCode, and stateOrRegion.

Spain

• You must specify the registrationType in the spainAdditionalInfo field of the additionalTaxInformation object.

• If the registrationType is Local, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

Turkey

• You must specify the sector in the taxRegistrationEntry object.

• If your sector is Business, Individual, or Government:

  • Specify the taxOffice. If your sector is Individual, don't enter this value.

  • (Optional) Specify the kepEmailId. If your sector is Individual, don't enter this value.

  • Note: In the Tax Settings page of the Billing console, Government appears as Public institutions

• If your sector is Business and you're subject to KDV tax, you must specify your industry in the industries field.

• For address, you must specify districtOrCounty.

Ukraine

• The sector valid values are Business and Individual.

Parameter Syntax

$result = $client->batchPutTaxRegistration([
    'accountIds' => ['<string>', ...], // REQUIRED
    'taxRegistrationEntry' => [ // REQUIRED
        'additionalTaxInformation' => [
            'canadaAdditionalInfo' => [
                'canadaQuebecSalesTaxNumber' => '<string>',
                'canadaRetailSalesTaxNumber' => '<string>',
                'isResellerAccount' => true || false,
                'provincialSalesTaxId' => '<string>',
            ],
            'estoniaAdditionalInfo' => [
                'registryCommercialCode' => '<string>', // REQUIRED
            ],
            'georgiaAdditionalInfo' => [
                'personType' => 'Legal Person|Physical Person|Business', // REQUIRED
            ],
            'israelAdditionalInfo' => [
                'customerType' => 'Business|Individual', // REQUIRED
                'dealerType' => 'Authorized|Non-authorized', // REQUIRED
            ],
            'italyAdditionalInfo' => [
                'cigNumber' => '<string>',
                'cupNumber' => '<string>',
                'sdiAccountId' => '<string>',
                'taxCode' => '<string>',
            ],
            'kenyaAdditionalInfo' => [
                'personType' => 'Legal Person|Physical Person|Business', // REQUIRED
            ],
            'malaysiaAdditionalInfo' => [
                'serviceTaxCodes' => ['<string>', ...], // REQUIRED
            ],
            'polandAdditionalInfo' => [
                'individualRegistrationNumber' => '<string>',
                'isGroupVatEnabled' => true || false,
            ],
            'romaniaAdditionalInfo' => [
                'taxRegistrationNumberType' => 'TaxRegistrationNumber|LocalRegistrationNumber', // REQUIRED
            ],
            'saudiArabiaAdditionalInfo' => [
                'taxRegistrationNumberType' => 'TaxRegistrationNumber|TaxIdentificationNumber|CommercialRegistrationNumber',
            ],
            'southKoreaAdditionalInfo' => [
                'businessRepresentativeName' => '<string>', // REQUIRED
                'itemOfBusiness' => '<string>', // REQUIRED
                'lineOfBusiness' => '<string>', // REQUIRED
            ],
            'spainAdditionalInfo' => [
                'registrationType' => 'Intra-EU|Local', // REQUIRED
            ],
            'turkeyAdditionalInfo' => [
                'industries' => 'CirculatingOrg|ProfessionalOrg|Banks|Insurance|PensionAndBenefitFunds|DevelopmentAgencies',
                'kepEmailId' => '<string>',
                'secondaryTaxId' => '<string>',
                'taxOffice' => '<string>',
            ],
            'ukraineAdditionalInfo' => [
                'ukraineTrnType' => 'Business|Individual', // REQUIRED
            ],
        ],
        'certifiedEmailId' => '<string>',
        'legalAddress' => [
            'addressLine1' => '<string>', // REQUIRED
            'addressLine2' => '<string>',
            'addressLine3' => '<string>',
            'city' => '<string>', // REQUIRED
            'countryCode' => '<string>', // REQUIRED
            'districtOrCounty' => '<string>',
            'postalCode' => '<string>', // REQUIRED
            'stateOrRegion' => '<string>',
        ],
        'legalName' => '<string>',
        'registrationId' => '<string>', // REQUIRED
        'registrationType' => 'VAT|GST|CPF|CNPJ|SST', // REQUIRED
        'sector' => 'Business|Individual|Government',
        'verificationDetails' => [
            'dateOfBirth' => '<string>',
            'taxRegistrationDocuments' => [
                [
                    's3Location' => [ // REQUIRED
                        'bucket' => '<string>', // REQUIRED
                        'key' => '<string>', // REQUIRED
                    ],
                ],
                // ...
            ],
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'accountId' => '<string>',
            'code' => '<string>',
            'message' => '<string>',
        ],
        // ...
    ],
    'status' => 'Verified|Pending|Deleted|Rejected',
]

Result Details

Errors

ValidationException:

The exception when the input doesn't pass validation for at least one of the input parameters.

ConflictException:

The exception when the input is creating conflict with the given state.

InternalServerException:

The exception thrown when an unexpected error occurs when processing a request.

DeleteTaxRegistration

$result = $client->deleteTaxRegistration([/* ... */]);
$promise = $client->deleteTaxRegistrationAsync([/* ... */]);

Deletes tax registration for a single account.

Parameter Syntax

$result = $client->deleteTaxRegistration([
    'accountId' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The exception when the input doesn't pass validation for at least one of the input parameters.

ConflictException:

The exception when the input is creating conflict with the given state.

ResourceNotFoundException:

The exception thrown when the input doesn't have a resource associated to it.

InternalServerException:

The exception thrown when an unexpected error occurs when processing a request.

GetTaxRegistration

$result = $client->getTaxRegistration([/* ... */]);
$promise = $client->getTaxRegistrationAsync([/* ... */]);

Retrieves tax registration for a single account.

Parameter Syntax

$result = $client->getTaxRegistration([
    'accountId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'taxRegistration' => [
        'additionalTaxInformation' => [
            'brazilAdditionalInfo' => [
                'ccmCode' => '<string>',
                'legalNatureCode' => '<string>',
            ],
            'canadaAdditionalInfo' => [
                'canadaQuebecSalesTaxNumber' => '<string>',
                'canadaRetailSalesTaxNumber' => '<string>',
                'isResellerAccount' => true || false,
                'provincialSalesTaxId' => '<string>',
            ],
            'estoniaAdditionalInfo' => [
                'registryCommercialCode' => '<string>',
            ],
            'georgiaAdditionalInfo' => [
                'personType' => 'Legal Person|Physical Person|Business',
            ],
            'indiaAdditionalInfo' => [
                'pan' => '<string>',
            ],
            'israelAdditionalInfo' => [
                'customerType' => 'Business|Individual',
                'dealerType' => 'Authorized|Non-authorized',
            ],
            'italyAdditionalInfo' => [
                'cigNumber' => '<string>',
                'cupNumber' => '<string>',
                'sdiAccountId' => '<string>',
                'taxCode' => '<string>',
            ],
            'kenyaAdditionalInfo' => [
                'personType' => 'Legal Person|Physical Person|Business',
            ],
            'malaysiaAdditionalInfo' => [
                'serviceTaxCodes' => ['<string>', ...],
            ],
            'polandAdditionalInfo' => [
                'individualRegistrationNumber' => '<string>',
                'isGroupVatEnabled' => true || false,
            ],
            'romaniaAdditionalInfo' => [
                'taxRegistrationNumberType' => 'TaxRegistrationNumber|LocalRegistrationNumber',
            ],
            'saudiArabiaAdditionalInfo' => [
                'taxRegistrationNumberType' => 'TaxRegistrationNumber|TaxIdentificationNumber|CommercialRegistrationNumber',
            ],
            'southKoreaAdditionalInfo' => [
                'businessRepresentativeName' => '<string>',
                'itemOfBusiness' => '<string>',
                'lineOfBusiness' => '<string>',
            ],
            'spainAdditionalInfo' => [
                'registrationType' => 'Intra-EU|Local',
            ],
            'turkeyAdditionalInfo' => [
                'industries' => 'CirculatingOrg|ProfessionalOrg|Banks|Insurance|PensionAndBenefitFunds|DevelopmentAgencies',
                'kepEmailId' => '<string>',
                'secondaryTaxId' => '<string>',
                'taxOffice' => '<string>',
            ],
            'ukraineAdditionalInfo' => [
                'ukraineTrnType' => 'Business|Individual',
            ],
        ],
        'certifiedEmailId' => '<string>',
        'legalAddress' => [
            'addressLine1' => '<string>',
            'addressLine2' => '<string>',
            'addressLine3' => '<string>',
            'city' => '<string>',
            'countryCode' => '<string>',
            'districtOrCounty' => '<string>',
            'postalCode' => '<string>',
            'stateOrRegion' => '<string>',
        ],
        'legalName' => '<string>',
        'registrationId' => '<string>',
        'registrationType' => 'VAT|GST|CPF|CNPJ|SST',
        'sector' => 'Business|Individual|Government',
        'status' => 'Verified|Pending|Deleted|Rejected',
        'taxDocumentMetadatas' => [
            [
                'taxDocumentAccessToken' => '<string>',
                'taxDocumentName' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ValidationException:

The exception when the input doesn't pass validation for at least one of the input parameters.

ResourceNotFoundException:

The exception thrown when the input doesn't have a resource associated to it.

InternalServerException:

The exception thrown when an unexpected error occurs when processing a request.

GetTaxRegistrationDocument

$result = $client->getTaxRegistrationDocument([/* ... */]);
$promise = $client->getTaxRegistrationDocumentAsync([/* ... */]);

Downloads your tax documents to the Amazon S3 bucket that you specify in your request.

Parameter Syntax

$result = $client->getTaxRegistrationDocument([
    'destinationS3Location' => [ // REQUIRED
        'bucket' => '<string>', // REQUIRED
        'prefix' => '<string>',
    ],
    'taxDocumentMetadata' => [ // REQUIRED
        'taxDocumentAccessToken' => '<string>', // REQUIRED
        'taxDocumentName' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'destinationFilePath' => '<string>',
]

Result Details

Errors

ValidationException:

The exception when the input doesn't pass validation for at least one of the input parameters.

InternalServerException:

The exception thrown when an unexpected error occurs when processing a request.

ListTaxRegistrations

$result = $client->listTaxRegistrations([/* ... */]);
$promise = $client->listTaxRegistrationsAsync([/* ... */]);

Retrieves the tax registration of accounts listed in a consolidated billing family. This can be used to retrieve up to 100 accounts' tax registrations in one call (default 50).

Parameter Syntax

$result = $client->listTaxRegistrations([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'accountDetails' => [
        [
            'accountId' => '<string>',
            'accountMetaData' => [
                'accountName' => '<string>',
                'address' => [
                    'addressLine1' => '<string>',
                    'addressLine2' => '<string>',
                    'addressLine3' => '<string>',
                    'city' => '<string>',
                    'countryCode' => '<string>',
                    'districtOrCounty' => '<string>',
                    'postalCode' => '<string>',
                    'stateOrRegion' => '<string>',
                ],
                'addressRoleMap' => [
                    '<AddressRoleType>' => [
                        'countryCode' => '<string>',
                        'stateOrRegion' => '<string>',
                    ],
                    // ...
                ],
                'addressType' => 'TaxAddress|BillingAddress|ContactAddress',
                'seller' => '<string>',
            ],
            'taxInheritanceDetails' => [
                'inheritanceObtainedReason' => '<string>',
                'parentEntityId' => '<string>',
            ],
            'taxRegistration' => [
                'additionalTaxInformation' => [
                    'brazilAdditionalInfo' => [
                        'ccmCode' => '<string>',
                        'legalNatureCode' => '<string>',
                    ],
                    'canadaAdditionalInfo' => [
                        'canadaQuebecSalesTaxNumber' => '<string>',
                        'canadaRetailSalesTaxNumber' => '<string>',
                        'isResellerAccount' => true || false,
                        'provincialSalesTaxId' => '<string>',
                    ],
                    'estoniaAdditionalInfo' => [
                        'registryCommercialCode' => '<string>',
                    ],
                    'georgiaAdditionalInfo' => [
                        'personType' => 'Legal Person|Physical Person|Business',
                    ],
                    'indiaAdditionalInfo' => [
                        'pan' => '<string>',
                    ],
                    'israelAdditionalInfo' => [
                        'customerType' => 'Business|Individual',
                        'dealerType' => 'Authorized|Non-authorized',
                    ],
                    'italyAdditionalInfo' => [
                        'cigNumber' => '<string>',
                        'cupNumber' => '<string>',
                        'sdiAccountId' => '<string>',
                        'taxCode' => '<string>',
                    ],
                    'kenyaAdditionalInfo' => [
                        'personType' => 'Legal Person|Physical Person|Business',
                    ],
                    'malaysiaAdditionalInfo' => [
                        'serviceTaxCodes' => ['<string>', ...],
                    ],
                    'polandAdditionalInfo' => [
                        'individualRegistrationNumber' => '<string>',
                        'isGroupVatEnabled' => true || false,
                    ],
                    'romaniaAdditionalInfo' => [
                        'taxRegistrationNumberType' => 'TaxRegistrationNumber|LocalRegistrationNumber',
                    ],
                    'saudiArabiaAdditionalInfo' => [
                        'taxRegistrationNumberType' => 'TaxRegistrationNumber|TaxIdentificationNumber|CommercialRegistrationNumber',
                    ],
                    'southKoreaAdditionalInfo' => [
                        'businessRepresentativeName' => '<string>',
                        'itemOfBusiness' => '<string>',
                        'lineOfBusiness' => '<string>',
                    ],
                    'spainAdditionalInfo' => [
                        'registrationType' => 'Intra-EU|Local',
                    ],
                    'turkeyAdditionalInfo' => [
                        'industries' => 'CirculatingOrg|ProfessionalOrg|Banks|Insurance|PensionAndBenefitFunds|DevelopmentAgencies',
                        'kepEmailId' => '<string>',
                        'secondaryTaxId' => '<string>',
                        'taxOffice' => '<string>',
                    ],
                    'ukraineAdditionalInfo' => [
                        'ukraineTrnType' => 'Business|Individual',
                    ],
                ],
                'certifiedEmailId' => '<string>',
                'jurisdiction' => [
                    'countryCode' => '<string>',
                    'stateOrRegion' => '<string>',
                ],
                'legalName' => '<string>',
                'registrationId' => '<string>',
                'registrationType' => 'VAT|GST|CPF|CNPJ|SST',
                'sector' => 'Business|Individual|Government',
                'status' => 'Verified|Pending|Deleted|Rejected',
                'taxDocumentMetadatas' => [
                    [
                        'taxDocumentAccessToken' => '<string>',
                        'taxDocumentName' => '<string>',
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The exception when the input doesn't pass validation for at least one of the input parameters.

ResourceNotFoundException:

The exception thrown when the input doesn't have a resource associated to it.

InternalServerException:

The exception thrown when an unexpected error occurs when processing a request.

PutTaxRegistration

$result = $client->putTaxRegistration([/* ... */]);
$promise = $client->putTaxRegistrationAsync([/* ... */]);

Adds or updates tax registration for a single account. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first.

To call this API operation for specific countries, see the following country-specific requirements.

Bangladesh

• You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

Brazil

• You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation.

• For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address.

Georgia

• The valid personType values are Physical Person and Business.

Kenya

• You must specify the personType in the kenyaAdditionalInfo field of the additionalTaxInformation object.

• If the personType is Physical Person, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

Malaysia

• If you use this operation to set a tax registration number (TRN) in Malaysia, only resellers with a valid sales and service tax (SST) number are required to provide tax registration information.

• By using this API operation to set a TRN in Malaysia, Amazon Web Services will regard you as self-declaring that you're an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD) and have a valid SST number.

• Amazon Web Services reserves the right to seek additional information and/or take other actions to support your self-declaration as appropriate.

• If you're not a reseller of Amazon Web Services, we don't recommend that you use this operation to set the TRN in Malaysia.

• Only use this API operation to upload the TRNs for accounts through which you're reselling Amazon Web Services.

• Amazon Web Services is currently registered under the following service tax codes. You must include at least one of the service tax codes in the service tax code strings to declare yourself as an authorized registered business reseller.

  Taxable service and service tax codes:

  Consultancy - 9907061674

  Training or coaching service - 9907071685

  IT service - 9907101676

  Digital services and electronic medium - 9907121690

Nepal

• The sector valid values are Business and Individual.

Saudi Arabia

• For address, you must specify addressLine3.

South Korea

• You must specify the certifiedEmailId and legalName in the TaxRegistrationEntry object. Use Korean characters for legalName.

• You must specify the businessRepresentativeName, itemOfBusiness, and lineOfBusiness in the southKoreaAdditionalInfo field of the additionalTaxInformation object. Use Korean characters for these fields.

• You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

• For the address object, use Korean characters for addressLine1, addressLine2 city, postalCode, and stateOrRegion.

Spain

• You must specify the registrationType in the spainAdditionalInfo field of the additionalTaxInformation object.

• If the registrationType is Local, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

Turkey

• You must specify the sector in the taxRegistrationEntry object.

• If your sector is Business, Individual, or Government:

  • Specify the taxOffice. If your sector is Individual, don't enter this value.

  • (Optional) Specify the kepEmailId. If your sector is Individual, don't enter this value.

  • Note: In the Tax Settings page of the Billing console, Government appears as Public institutions

• If your sector is Business and you're subject to KDV tax, you must specify your industry in the industries field.

• For address, you must specify districtOrCounty.

Ukraine

• The sector valid values are Business and Individual.

Parameter Syntax

$result = $client->putTaxRegistration([
    'accountId' => '<string>',
    'taxRegistrationEntry' => [ // REQUIRED
        'additionalTaxInformation' => [
            'canadaAdditionalInfo' => [
                'canadaQuebecSalesTaxNumber' => '<string>',
                'canadaRetailSalesTaxNumber' => '<string>',
                'isResellerAccount' => true || false,
                'provincialSalesTaxId' => '<string>',
            ],
            'estoniaAdditionalInfo' => [
                'registryCommercialCode' => '<string>', // REQUIRED
            ],
            'georgiaAdditionalInfo' => [
                'personType' => 'Legal Person|Physical Person|Business', // REQUIRED
            ],
            'israelAdditionalInfo' => [
                'customerType' => 'Business|Individual', // REQUIRED
                'dealerType' => 'Authorized|Non-authorized', // REQUIRED
            ],
            'italyAdditionalInfo' => [
                'cigNumber' => '<string>',
                'cupNumber' => '<string>',
                'sdiAccountId' => '<string>',
                'taxCode' => '<string>',
            ],
            'kenyaAdditionalInfo' => [
                'personType' => 'Legal Person|Physical Person|Business', // REQUIRED
            ],
            'malaysiaAdditionalInfo' => [
                'serviceTaxCodes' => ['<string>', ...], // REQUIRED
            ],
            'polandAdditionalInfo' => [
                'individualRegistrationNumber' => '<string>',
                'isGroupVatEnabled' => true || false,
            ],
            'romaniaAdditionalInfo' => [
                'taxRegistrationNumberType' => 'TaxRegistrationNumber|LocalRegistrationNumber', // REQUIRED
            ],
            'saudiArabiaAdditionalInfo' => [
                'taxRegistrationNumberType' => 'TaxRegistrationNumber|TaxIdentificationNumber|CommercialRegistrationNumber',
            ],
            'southKoreaAdditionalInfo' => [
                'businessRepresentativeName' => '<string>', // REQUIRED
                'itemOfBusiness' => '<string>', // REQUIRED
                'lineOfBusiness' => '<string>', // REQUIRED
            ],
            'spainAdditionalInfo' => [
                'registrationType' => 'Intra-EU|Local', // REQUIRED
            ],
            'turkeyAdditionalInfo' => [
                'industries' => 'CirculatingOrg|ProfessionalOrg|Banks|Insurance|PensionAndBenefitFunds|DevelopmentAgencies',
                'kepEmailId' => '<string>',
                'secondaryTaxId' => '<string>',
                'taxOffice' => '<string>',
            ],
            'ukraineAdditionalInfo' => [
                'ukraineTrnType' => 'Business|Individual', // REQUIRED
            ],
        ],
        'certifiedEmailId' => '<string>',
        'legalAddress' => [
            'addressLine1' => '<string>', // REQUIRED
            'addressLine2' => '<string>',
            'addressLine3' => '<string>',
            'city' => '<string>', // REQUIRED
            'countryCode' => '<string>', // REQUIRED
            'districtOrCounty' => '<string>',
            'postalCode' => '<string>', // REQUIRED
            'stateOrRegion' => '<string>',
        ],
        'legalName' => '<string>',
        'registrationId' => '<string>', // REQUIRED
        'registrationType' => 'VAT|GST|CPF|CNPJ|SST', // REQUIRED
        'sector' => 'Business|Individual|Government',
        'verificationDetails' => [
            'dateOfBirth' => '<string>',
            'taxRegistrationDocuments' => [
                [
                    's3Location' => [ // REQUIRED
                        'bucket' => '<string>', // REQUIRED
                        'key' => '<string>', // REQUIRED
                    ],
                ],
                // ...
            ],
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'status' => 'Verified|Pending|Deleted|Rejected',
]

Result Details

Errors

ValidationException:

The exception when the input doesn't pass validation for at least one of the input parameters.

ConflictException:

The exception when the input is creating conflict with the given state.

InternalServerException:

The exception thrown when an unexpected error occurs when processing a request.