tfnVerificationIdstring required
The unique identifier for the TFN verification request, generated by the server.
status'STATUS_UNSPECIFIED' | 'WAITING' | 'IN_PROGRESS' | 'VERIFIED' | 'REJECTED' required
createTimestring date-time required
The timestamp when the verification was created, in UTC (RFC3339 format).
createdBystring email
The email of the user who initiated the request.
phoneNumberstring required
Toll-Free Number that is procured, hosted or in the process of hosting with Sinch. Must be in E.164 format.
businessNamestring required
businessAddress1string required
businessCitystring required
businessStatestring required
businessZipCodestring required
businessContactFirstNamestring required
businessContactLastNamestring required
businessContactEmailstring email required
businessContactPhonestring required
corporateWebsitestring required
messageVolumestring required
Estimate monthly volume of messages from the TFN (accepted values: 10, 100, 1000, 10000, 100000, 250000, 500000, 750000, 1000000, 5000000, 10000000+)
useCasestring required
Category of the use case, fetched from the dedicated API.
useCaseSummarystring required
General idea of the use case and customer.
productionMessageContentstring required
Example of message content.
optInWorkflowDescriptionstring required
Description of the opt-in workflow.
optInWorkflowImageUrlsstring[] required
Images showing the opt-in workflow.
additionalInformationstring
Any additional information.
businessRegistrationNumberstring required
A legally recognized business registration number.
businessType'SOLE_PROPRIETOR' | 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT' required
The type of business, selected from a list of predefined categories.
businessRegistrationCountrystring required
Country business is registered in.
campaignVerifyAuthorizationTokenstring password
Campaign tokens for customers. This is a sensitive, write-only field.
businessRegistrationTypestring required
The type of business registration (e.g. EIN, CBN, CRN, NEQ, Provincial Number, VAT, ACN, ABN, BRN)
businessDbastring
The "doing business as" (DBA) name of the business.
termsAndConditionsUrlstring uri
A URL to a page containing the terms and conditions. Optional until September 15, 2026, when it becomes required.
privacyPolicyUrlstring uri
A URL to a page containing the privacy policy. Optional until September 15, 2026, when it becomes required.