Skip to main content

Import External Vetting Record

PUT 
/brand/:brandId/externalVetting

This operation can be used to import an external vetting record from a TCR-approved vetting provider. If the vetting provider confirms validity of the record, it will be saved with the brand and will be considered for future campaign qualification.

Request ​

Path Parameters

    brandId Brandidrequired

Body

required

    evpId Evpid (string)required

    Possible values: <= 10 characters

    External vetting provider ID for the brand.

    vettingId 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 Vettingtoken (string)

    Required by some providers for vetting record confirmation.

Responses ​

200: Successful Response

Schema

    evpId Evpid (string)

    Possible values: <= 10 characters

    External vetting provider ID for the brand.

    vettingId 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 vettingToken (string)

    Required by some providers for vetting record confirmation.

    vettingScore vettingScore (integer)

    Vetting score ranging from 0-100.

    vettingClass Vettingclass (string)

    Identifies the vetting classification.

    vettedDate 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 createDate (string)

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

422: Validation Error

Schema

    detail

    object[]

  • Array [

    • loc

    object[]

    required

  • Array [

    • anyOf

    string

  • ]

    • msg Message (string)required
    type Error Type (string)required

  • ]

Request samples

curl -L -X PUT 'https://api.telnyx.com/10dlc/brand/:brandId/externalVetting' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "evpId": "string",
  "vettingId": "string",
  "vettingToken": "string"
}'

Response samples

{
  "evpId": "string",
  "vettingId": "string",
  "vettingToken": "string",
  "vettingScore": 0,
  "vettingClass": "string",
  "vettedDate": "string",
  "createDate": "string"
}