Brands

Order Brand External Vetting

Changed on

Order new external vetting for a brand.

Duplicate orders for the same evpId and vettingClass return 400 with code 10012 if a successful vetting exists within the last 180 days, or one is currently being processed. Failed vettings can be retried immediately.

post/10dlc/brand/{brandId}/externalVetting

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/10dlc/brand/{brandId}/externalVetting
  • Auth: HTTP bearer

Path parameters

brandIdstring required

Unique identifier of the brand.

Request body

evpIdstring required

External vetting provider ID for the brand.

vettingClassstring required

Identifies the vetting classification.

Response

Successful Response

evpIdstring

External vetting provider ID for the brand.

vettingIdstring

Unique ID that identifies a vetting transaction performed by a vetting provider. This ID is provided by the vetting provider at time of vetting.

vettingTokenstring

Required by some providers for vetting record confirmation.

vettingScoreinteger

Vetting score ranging from 0-100.

vettingClassstring

Identifies the vetting classification.

vettedDatestring

Vetting effective date. This is the date when vetting was completed, or the starting effective date in ISO 8601 format. If this date is missing, then the vetting was not complete or not valid.

createDatestring

Vetting submission date. This is the date when the vetting request is generated in ISO 8601 format.

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • info

      added the optional property // to the response with the status