Order Brand External Vetting

Order new external vetting for a brand

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

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.messaging10dlc.brand.externalVetting.order('brandId', {
  evpId: 'evpId',
  vettingClass: 'vettingClass',
});

console.log(response.createDate);

200

{
  "evpId": "<string>",
  "vettingId": "<string>",
  "vettingToken": "<string>",
  "vettingScore": 123,
  "vettingClass": "<string>",
  "vettedDate": "<string>",
  "createDate": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brandId · string · required

Body

application/json

evpId · string · required

External vetting provider ID for the brand.

Maximum string length: 10

vettingClass · string · required

Identifies the vetting classification.

Response

200

application/json

Successful Response

evpId · string

External vetting provider ID for the brand.

Maximum string length: 10

vettingId · string

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

vettingToken · string

Required by some providers for vetting record confirmation.

vettingScore · integer

Vetting score ranging from 0-100.

vettingClass · string

Identifies the vetting classification.

vettedDate · string

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.

createDate · string

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