Verification Methods: List
Retrieve verification methods for entities in an account
path Parameters
| accountId required | string |
| publisherId required | string |
| locale required | string Locale code. |
query Parameters
| v required | string A date in |
| entityIds | string A comma-separated list of Entity IDs. If no IDs are specified, defaults to all entities with a listings subscription. |
| pageToken | string If a response to a previous request contained the |
| limit | integer Default: 100 Number of results to return. |
| offset | integer Default: 0 Number of results to skip. Used to page through results.
Cannot be used together with |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "count": 0,
- "verificationMethods": [
- {
- "entityId": "string",
- "publisherId": "string",
- "addressData": [
- {
- "businessName": "string",
- "address": "string"
}
], - "phoneData": [
- {
- "number": "string"
}
], - "emailData": [
- {
- "domainName": "string",
- "userName": "string",
- "userNameEditable": true
}
]
}
], - "nextPageToken": "string"
}
}Verification Statuses: List
Retrieve verification statuses for entities in an account
path Parameters
| accountId required | string |
| publisherId required | string |
query Parameters
| v required | string A date in |
| entityIds | string A comma-separated list of Entity IDs. If no IDs are specified, defaults to all entities with a listings subscription. |
| pageToken | string If a response to a previous request contained the |
| limit | integer Default: 100 Number of results to return. |
| offset | integer Default: 0 Number of results to skip. Used to page through results.
Cannot be used together with |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "count": 0,
- "verifications": [
- {
- "entityId": "string",
- "state": "VERIFICATION_STATE_UNSPECIFIED",
- "createTime": "string"
}
], - "nextPageToken": "string"
}
}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 |
Request Body schema: application/json
| 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 |
| recipientName | string Contact name the mail should be addressed to.
Only applies if the verification |
Responses
Request samples
- Payload
[- {
- "entityId": "string",
- "method": "POSTCARD",
- "alternateEmail": "string",
- "recipientName": "string"
}
]Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "count": 0,
- "entityIds": [
- "string"
]
}
}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 |
Request Body schema: application/json
| entityId | string ID of the entity being verified. |
| verificationCode | string The verification code received from the publisher. |
Responses
Request samples
- Payload
[- {
- "entityId": "string",
- "verificationCode": "string"
}
]Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "count": 0,
- "entityIds": [
- "string"
]
}
}