Partner Central Account API

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

Request Syntax

client.get_verification(
    VerificationType='BUSINESS_VERIFICATION'|'REGISTRANT_VERIFICATION'
)

type VerificationType:

string

param VerificationType:

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

rtype:

dict

returns:

Response Syntax

{
    'VerificationType': 'BUSINESS_VERIFICATION'|'REGISTRANT_VERIFICATION',
    'VerificationStatus': 'PENDING_CUSTOMER_ACTION'|'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'REJECTED',
    'VerificationStatusReason': 'string',
    'VerificationResponseDetails': {
        'BusinessVerificationResponse': {
            'BusinessVerificationDetails': {
                'LegalName': 'string',
                'RegistrationId': 'string',
                'CountryCode': 'string',
                'JurisdictionOfIncorporation': 'string'
            }
        },
        'RegistrantVerificationResponse': {
            'CompletionUrl': 'string',
            'CompletionUrlExpiresAt': datetime(2015, 1, 1)
        }
    },
    'StartedAt': datetime(2015, 1, 1),
    'CompletedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) --

  • VerificationType (string) --

    The type of verification that was requested and processed.

  • VerificationStatus (string) --

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

  • VerificationStatusReason (string) --

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

  • VerificationResponseDetails (dict) --

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

    • BusinessVerificationResponse (dict) --

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

      • BusinessVerificationDetails (dict) --

        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 (dict) --

      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 (datetime) --

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

  • StartedAt (datetime) --

    The timestamp when the verification process was initiated.

  • CompletedAt (datetime) --

    The timestamp when the verification process was completed. This field is null if the verification is still in progress.

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

Request Syntax

client.start_verification(
    ClientToken='string',
    VerificationDetails={
        'BusinessVerificationDetails': {
            'LegalName': 'string',
            'RegistrationId': 'string',
            'CountryCode': 'string',
            'JurisdictionOfIncorporation': 'string'
        },
        'RegistrantVerificationDetails': {}

    }
)

type ClientToken:

string

param ClientToken:

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

This field is autopopulated if not provided.

type VerificationDetails:

dict

param VerificationDetails:

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

• BusinessVerificationDetails (dict) --

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

  • LegalName (string) -- [REQUIRED]

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

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

  • CountryCode (string) -- [REQUIRED]

    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 (dict) --

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

rtype:

dict

returns:

Response Syntax

{
    'VerificationType': 'BUSINESS_VERIFICATION'|'REGISTRANT_VERIFICATION',
    'VerificationStatus': 'PENDING_CUSTOMER_ACTION'|'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'REJECTED',
    'VerificationStatusReason': 'string',
    'VerificationResponseDetails': {
        'BusinessVerificationResponse': {
            'BusinessVerificationDetails': {
                'LegalName': 'string',
                'RegistrationId': 'string',
                'CountryCode': 'string',
                'JurisdictionOfIncorporation': 'string'
            }
        },
        'RegistrantVerificationResponse': {
            'CompletionUrl': 'string',
            'CompletionUrlExpiresAt': datetime(2015, 1, 1)
        }
    },
    'StartedAt': datetime(2015, 1, 1),
    'CompletedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) --

  • 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 (dict) --

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

    • BusinessVerificationResponse (dict) --

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

      • BusinessVerificationDetails (dict) --

        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 (dict) --

      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 (datetime) --

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

  • StartedAt (datetime) --

    The timestamp when the verification process was successfully initiated.

  • CompletedAt (datetime) --

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