WAwavix
10DLC

List external vetting appeals

Changed on

Returns the external vetting appeals for the 10DLC Brand identified by brand_id.

get/v3/10dlc/brands/{brand_id}/vettings/appeals

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v3/10dlc/brands/{brand_id}/vettings/appeals
  • Auth
    HTTP bearer

Path parameters

brand_idstring required
Example:BMQFB7X

The unique ID of the 10DLC Brand.

Response

Returns the list of external vetting appeals.

appeal_statusstring required

Current status of the appeal, such as PENDING or COMPLETE.

appeal_status_update_datestring required

Timestamp when the appeal status was last updated, in ISO 8601 format.

attachment_uuid_liststring[] required

UUIDs of the evidence files submitted in support of the appeal.

brand_idstring required

Unique identifier of the Brand the appeal is associated with.

category_liststring[] required

Categories that classify the appeal, such as LOW_SCORE.

create_datestring required

Timestamp when the appeal was created, in ISO 8601 format.

explanationstring required

Justification provided for the appeal.

evp_idstring required

Code identifying the external vetting provider that handled the appeal.

vetting_classstring required

Class of the vetting being appealed, such as STANDARD or ENHANCED.

vetting_idstring required

Unique identifier of the vetting request being appealed.

Example response

[
  {
    "appeal_outcome": {
      "vet_status": "ACTIVE",
      "vet_score": 80,
      "feedback": {
        "reasons": [
          "Company size as reported by government or business sources resulted in a score deduction: size range 6-10."
        ]
      }
    },
    "appeal_status": "COMPLETE",
    "appeal_status_update_date": "2024-08-15T08:42:31",
    "attachment_uuid_list": [],
    "brand_id": "BMQFB7X",
    "category_list": [
      "LOW_SCORE"
    ],
    "create_date": "2024-08-15T08:41:05",
    "evp_id": "AEGIS",
    "explanation": "This is an API test",
    "vetting_class": "STANDARD",
    "vetting_id": "48c0ffaa-4e51-4d44-3982-08dcb9856232"
  }
]

Changes

  • d4db3aae3627Revision changes
    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the /// response's property type changed from no type to object for status

  • 6a89c962481cRevision changes
    • breaking

      added the pattern ^B[A-Z0-9]{6}$ to the path request parameter brand_id

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the / response's property format changed from date-time to no format for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status