Select the brand you are checking
Use the brand ID from your account. Keep it with the resulting vetting records so a review for one business is not mistaken for another business’s review. Do not use another account’s identifiers.
Follow an existing review
Keep the vettingId, evpId, vettingClass and vettingStatus when present. The current synchronization treats PENDING and UNSCORE as results still awaiting further checking, and ACTIVE and FAILED as terminal results for settlement. Read the returned details before deciding whether any follow-up is needed. An empty list alone is not proof that a previous submission did not reach the registry.
Understand charges for an earlier order
Checking status does not order another review. It can, however, reconcile a completed result and settle the charge attached to an earlier billable review request. This includes an applicable failure charge. Use the price and terms reviewed at the time of ordering; do not infer today’s price from an old example or a status response.
Retry the read without submitting another order
For a transient failure, retain the brand and known vetting IDs, respect Retry-After and retry this read with backoff. Do not submit a new review order merely because the status lookup failed or returned an unexpected body. For a persistent mismatch, contact MultiTEL with the relevant reference IDs through an authenticated support channel.
Keep registration steps separate
Vetting establishes a review result for the brand. Campaign qualification, campaign registration and number assignment remain separate steps. Check their current status and requirements before sending messages.
Request
Use an enabled API account over HTTPS from an allowed source IP address. Use your account credentials, not registry credentials. The brand must be associated with the authenticated account.
GET with the brand ID in the path and the required vettingStatus query filter. The reviewed schema defines an array of statuses; this example requests one ACTIVE value. Multiple-value encoding and unfiltered provider acceptance are not established by this guide. No request body is required.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/brand/$BRAND_ID/externalVetting?vettingStatus=ACTIVE"| Name | Type | Required | Description |
|---|---|---|---|
brandId | string | Yes | The registry brand ID associated with your MultiTEL account. This is not your account ID or a vetting ID. |
| Name | Type | Required | Description |
|---|---|---|---|
vettingStatus | array of strings | Yes | Required status filter. Allowed values: PENDING, UNSCORE, ACTIVE, FAILED, EXPIRED. The example supplies one ACTIVE value; no multiple-value encoding or unfiltered provider acceptance is claimed. |
Response
The current route preserves the registry HTTP status and body rather than using the legacy v3 response envelope. The abbreviated fictional array illustrates fields consumed by the local synchronization path; it is not a captured registry response or a guaranteed complete schema. Check HTTP status and JSON before reading records. Keep each vettingId with the selected brand.
Illustrative response shape; not live account data or a current quote.
[
{
"vettingId": "example-vetting-id",
"evpId": "example-review-provider",
"vettingClass": "STANDARD",
"vettingStatus": "ACTIVE"
}
]Errors
- 401: Account authentication failed. Check credentials, API enabled state and applicable source-IP restrictions.
- 404: The brand is not associated with this account, or the registry could not find it. An account-ownership denial occurs before the registry request.
- 429: Account or registry request limit reached. Respect Retry-After and use backoff.
- 502/503: Transport, registry, request-limiter or local processing is unavailable. An error does not establish that an earlier review request failed.
Availability and side effects
- This GET does not place a new vetting order. It retrieves registry results, writes request audit records and synchronizes stored results.
- Reading a completed result can settle the charge for a previously placed billable vetting order. A failed review may carry an applicable failure charge. Review the price and terms when ordering; this read is not a price quote.
- A newly discovered record imported by this GET is not automatically classified as a new billable order.
- A successful or ACTIVE vetting result is not campaign approval, phone-number assignment or permission to send messages.