Skip to main content

Submit Verification Request

POST 

/messaging_tollfree/verification/requests

Submit a new tollfree verification request

Request

Body

required

    businessName Businessnamerequired
    corporateWebsite Corporatewebsiterequired
    businessAddr1 Businessaddr1required
    businessAddr2 Businessaddr2
    businessCity Businesscityrequired
    businessState Businessstaterequired
    businessZip Businessziprequired
    businessContactFirstName Businesscontactfirstnamerequired
    businessContactLastName Businesscontactlastnamerequired
    businessContactEmail Businesscontactemailrequired
    businessContactPhone Businesscontactphonerequired
    messageVolume object

    Message Volume Enums

    phoneNumbers

    object[]

    required

  • Array [

  • phoneNumber Phonenumberrequired
  • ]

  • useCase object

    Tollfree usecase categories

    useCaseSummary Usecasesummaryrequired
    productionMessageContent Productionmessagecontentrequired
    optInWorkflow Optinworkflowrequired

    optInWorkflowImageURLs

    object[]

    required

    Possible values: >= 1

  • Array [

  • url urirequired

    Possible values: non-empty and <= 2083 characters

  • ]

  • additionalInformation Additionalinformationrequired
    isvReseller Isvresellerrequired
    webhookUrl Webhookurl

Responses

200: Successful Response

Schema

    businessName Businessnamerequired
    corporateWebsite Corporatewebsiterequired
    businessAddr1 Businessaddr1required
    businessAddr2 Businessaddr2
    businessCity Businesscityrequired
    businessState Businessstaterequired
    businessZip Businessziprequired
    businessContactFirstName Businesscontactfirstnamerequired
    businessContactLastName Businesscontactlastnamerequired
    businessContactEmail Businesscontactemailrequired
    businessContactPhone Businesscontactphonerequired
    messageVolume object

    Message Volume Enums

    phoneNumbers

    object[]

    required

  • Array [

  • phoneNumber Phonenumberrequired
  • ]

  • useCase object

    Tollfree usecase categories

    useCaseSummary Usecasesummaryrequired
    productionMessageContent Productionmessagecontentrequired
    optInWorkflow Optinworkflowrequired

    optInWorkflowImageURLs

    object[]

    required

  • Array [

  • url urirequired

    Possible values: non-empty and <= 2083 characters

  • ]

  • additionalInformation Additionalinformationrequired
    isvReseller Isvresellerrequired
    webhookUrl Webhookurl
    id uuidrequired
    verificationRequestId Verificationrequestidrequired
    verificationStatus object

    Tollfree verification status

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

  • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object
  • ]

Loading...