Skip to main content
PUT
/
brand
/
{brandId}
/
externalVetting
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const response = await client.brand.externalVetting.import('brandId', {
  evpId: 'evpId',
  vettingId: 'vettingId',
});

console.log(response.createDate);
{
  "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
​
vettingId
string
required

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.

Response

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.