Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . partnercentral-account ]

start-verification

Description

Initiates a new verification process for a partner account. This operation begins the verification workflow for either business registration or individual registrant identity verification as required by AWS Partner Central.

See also: AWS API Documentation

Synopsis

  start-verification
[--client-token <value>]
[--verification-details <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This prevents duplicate verification processes from being started accidentally.

--verification-details (tagged union structure)

The specific details required for the verification process, including business information for business verification or personal information for registrant verification.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: BusinessVerificationDetails, RegistrantVerificationDetails.

BusinessVerificationDetails -> (structure)

The business verification details to be used when starting a business verification process.

LegalName -> (string)

The official legal name of the business as registered with the appropriate government authorities.

RegistrationId -> (string)

The unique business registration identifier assigned by the government or regulatory authority, such as a company registration number or tax identification number.

CountryCode -> (string)

The ISO 3166-1 alpha-2 country code where the business is legally registered and operates.

JurisdictionOfIncorporation -> (string)

The specific legal jurisdiction or state where the business was incorporated or registered, providing additional location context beyond the country code.

RegistrantVerificationDetails -> (structure)

The registrant verification details to be used when starting an individual identity verification process.

Shorthand Syntax:

BusinessVerificationDetails={LegalName=string,RegistrationId=string,CountryCode=string,JurisdictionOfIncorporation=string},RegistrantVerificationDetails={}

JSON Syntax:

{
  "BusinessVerificationDetails": {
    "LegalName": "string",
    "RegistrationId": "string",
    "CountryCode": "string",
    "JurisdictionOfIncorporation": "string"
  },
  "RegistrantVerificationDetails": {

  }
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

VerificationType -> (string)

The type of verification that was started based on the provided verification details.

VerificationStatus -> (string)

The initial status of the verification process after it has been started. Typically this will be pending or in-progress.

VerificationStatusReason -> (string)

Additional information about the initial verification status, including any immediate feedback about the submitted verification details.

VerificationResponseDetails -> (tagged union structure)

Initial response details specific to the type of verification started, which may include next steps or additional requirements.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: BusinessVerificationResponse, RegistrantVerificationResponse.

BusinessVerificationResponse -> (structure)

The response details from a business verification process, including verification results and any additional business information discovered.

BusinessVerificationDetails -> (structure)

The business verification details that were processed and verified, potentially including additional information discovered during the verification process.

LegalName -> (string)

The official legal name of the business as registered with the appropriate government authorities.

RegistrationId -> (string)

The unique business registration identifier assigned by the government or regulatory authority, such as a company registration number or tax identification number.

CountryCode -> (string)

The ISO 3166-1 alpha-2 country code where the business is legally registered and operates.

JurisdictionOfIncorporation -> (string)

The specific legal jurisdiction or state where the business was incorporated or registered, providing additional location context beyond the country code.

RegistrantVerificationResponse -> (structure)

The response details from a registrant verification process, including verification results and any additional steps required for identity confirmation.

CompletionUrl -> (string)

A secure URL where the registrant can complete additional verification steps, such as document upload or identity confirmation through a third-party verification service.

CompletionUrlExpiresAt -> (timestamp)

The timestamp when the completion URL expires and is no longer valid for accessing the verification workflow.

StartedAt -> (timestamp)

The timestamp when the verification process was successfully initiated.

CompletedAt -> (timestamp)

The timestamp when the verification process was completed. This field is typically null for newly started verifications unless they complete immediately.