loading

Verification: Initiate

Initiate verification for entities in an account. This request will trigger verification codes being sent to the specified addresses, phone numbers, or email addresses.

path Parameters
accountId
required
string
publisherId
required
string
locale
required
string

Locale code.

query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
Array
entityId
string

ID of the entity being verified.

method
string
Enum: "POSTCARD" "EMAIL" "PHONE" "SMS"
alternateEmail
string

Provides a user-specified email address that the verification code should be sent to when userNameEditable is true in the VerificationMethod response.

recipientName
string

Contact name the mail should be addressed to. Only applies if the verification method is POSTCARD.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Verification: Complete

Provides verification codes to complete the verification for entities in an account.

path Parameters
accountId
required
string
publisherId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
Array
entityId
string

ID of the entity being verified.

verificationCode
string

The verification code received from the publisher.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}