Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetVerification

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.

Request Syntax


{
   "VerificationType": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

VerificationType

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

Type: String

Valid Values: BUSINESS_VERIFICATION | REGISTRANT_VERIFICATION

Required: Yes

Response Syntax


{
   "CompletedAt": "string",
   "StartedAt": "string",
   "VerificationResponseDetails": { ... },
   "VerificationStatus": "string",
   "VerificationStatusReason": "string",
   "VerificationType": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

StartedAt

The timestamp when the verification process was initiated.

Type: Timestamp

VerificationResponseDetails

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

Type: VerificationResponseDetails object

Note: This object is a Union. Only one member of this object can be specified or returned.

VerificationStatus

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

Type: String

Valid Values: PENDING_CUSTOMER_ACTION | IN_PROGRESS | FAILED | SUCCEEDED | REJECTED

VerificationType

The type of verification that was requested and processed.

Type: String

Valid Values: BUSINESS_VERIFICATION | REGISTRANT_VERIFICATION

CompletedAt

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

Type: Timestamp

VerificationStatusReason

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: [\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.

Reason: The specific reason for the access denial.

HTTP Status Code: 400

InternalServerException

An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.

Reason: The specific reason why the resource was not found.

HTTP Status Code: 400

ThrottlingException

The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.

QuotaCode: The quota code associated with the throttling error.
ServiceCode: The service code associated with the throttling error.

HTTP Status Code: 400

ValidationException

The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.

ErrorDetails: A list of detailed validation errors that occurred during request processing.
Reason: The reason for the validation failure.

HTTP Status Code: 400