SIsinch
TFN Verification

Create TFN Verifications

Changed on

Create a TFN verification.

post/v1/projects/{projectId}/tfnVerification

Request

  • Base URL
    https://us10dlc.numbers.api.sinch.com
  • URL
    https://us10dlc.numbers.api.sinch.com/v1/projects/{projectId}/tfnVerification
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://auth.sinch.com/oauth2/token

Path parameters

projectIdstring required

Sinch uses projects to group resources such as contacts and apps together to manage and connect a unique set of keys and secret IDs for all your Sinch API products. To identify a project, it is given a unique alphanumeric identifier that ties it to your account. Your project ID can be found in the Customer Dashboard.

Request body

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).

projectIdstring required

Your project ID can be found in the Customer Dashboard.

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
businessAddress2string
businessCitystring required
businessStatestring required
businessZipCodestring required
businessCountrystring
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 required

A URL to a page containing the terms and conditions.

privacyPolicyUrlstring uri required

A URL to a page containing the privacy policy.

Example request

{
  "termsAndConditionsUrl": "https://www.example.com/terms",
  "privacyPolicyUrl": "https://www.example.com/privacy-policy"
}

Response

A successful response.

tfnVerificationIdstring

Changes

  • bcae5eb8fc9fRevision changes
    • breaking

      the request property / became required

    • breaking

      the request property / became required

  • 9eecb207c30dRevision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /