Method: customers.getIdentityVerification

Returns Identity Verification information.

List of thrown errors: AuthenticationError AuthorizationError HeaderError InternalError QuotaError RequestError

HTTP request

GET https://googleads.googleapis.com/v16/customers/{customerId}/getIdentityVerification

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer for whom we are requesting verification information.

Request body

The request body must be empty.

Response body

Response message for [IdentityVerificationService.GetIdentityVerification].

If successful, the response body contains data with the following structure:

JSON representation 
{
  "identityVerification": [
    {
      object (IdentityVerification)
    }
  ]
}
Fields
identityVerification[]

object (IdentityVerification)

List of identity verifications for the customer.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

IdentityVerification

An identity verification for a customer.

JSON representation 
{
  "verificationProgram": enum (IdentityVerificationProgram),
  "identityVerificationRequirement": {
    object (IdentityVerificationRequirement)
  },
  "verificationProgress": {
    object (IdentityVerificationProgress)
  }
}
Fields
verificationProgram

enum (IdentityVerificationProgram)

The verification program type.
identityVerificationRequirement

object (IdentityVerificationRequirement)

The verification requirement for this verification program for this customer.
verificationProgress

object (IdentityVerificationProgress)

Information regarding progress for this verification program for this customer.

IdentityVerificationRequirement

Information regarding the verification requirement for a verification program type.

JSON representation 
{
  "verificationStartDeadlineTime": string,
  "verificationCompletionDeadlineTime": string
}
Fields
verificationStartDeadlineTime

string

The deadline to start verification in "yyyy-MM-dd HH:mm:ss" format.
verificationCompletionDeadlineTime

string

The deadline to submit verification.

IdentityVerificationProgress

Information regarding the verification progress for a verification program type.

JSON representation 
{
  "programStatus": enum (IdentityVerificationProgramStatus),
  "invitationLinkExpirationTime": string,
  "actionUrl": string
}
Fields
programStatus

enum (IdentityVerificationProgramStatus)

Current Status (PENDING_USER_ACTION, SUCCESS, FAILURE etc)
actionUrl

string

Action URL for user to complete verification for the given verification program type.

IdentityVerificationProgramStatus

Program status of identity verification.

Enums
UNSPECIFIED Not specified.
UNKNOWN The value is unknown in this version.
PENDING_USER_ACTION Verification is pending on user action to proceed.
PENDING_REVIEW Verification is pending on review.
SUCCESS Verification succeeded.
FAILURE Verification failed.