AWS CLI Command Reference

[ aws . partnercentral-account ]

get-verification

Description

Retrieves the current status and details of a verification process for a partner account. This operation allows partners to check the progress and results of business or registrant verification processes.

See also: AWS API Documentation

Synopsis

  get-verification
--verification-type <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--verification-type (string) [required]

The type of verification to retrieve information for. Valid values include business verification for company registration details and registrant verification for individual identity confirmation.

Possible values:

  • BUSINESS_VERIFICATION
  • REGISTRANT_VERIFICATION

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
  • yaml
  • yaml-stream

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

VerificationType -> (string)

The type of verification that was requested and processed.

Possible values:

  • BUSINESS_VERIFICATION
  • REGISTRANT_VERIFICATION

VerificationStatus -> (string)

The current status of the verification process. Possible values include pending, in-progress, completed, failed, or expired.

Possible values:

  • PENDING_CUSTOMER_ACTION
  • IN_PROGRESS
  • FAILED
  • SUCCEEDED
  • REJECTED

VerificationStatusReason -> (string)

Additional information explaining the current verification status, particularly useful when the status indicates a failure or requires additional action.

Constraints:

  • min: 1
  • max: 200
  • pattern: [\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+

VerificationResponseDetails -> (tagged union structure)

Detailed response information specific to the type of verification performed, including any verification-specific data or results.

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) [required]

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

LegalName -> (string) [required]

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

Constraints:

  • min: 1
  • max: 80
  • pattern: [\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+

RegistrationId -> (string) [required]

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

Constraints:

  • min: 1
  • max: 80
  • pattern: [\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+

CountryCode -> (string) [required]

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

Constraints:

  • min: 2
  • max: 2
  • pattern: [A-Z]{2}

JurisdictionOfIncorporation -> (string)

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

Constraints:

  • min: 2
  • max: 2
  • pattern: [A-Z0-9]{2}

RegistrantVerificationResponse -> (structure)

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

CompletionUrl -> (string) [required]

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) [required]

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 initiated.

CompletedAt -> (timestamp)

The timestamp when the verification process was completed. This field is null if the verification is still in progress.
© Copyright 2025, Amazon Web Services. Created using Sphinx.