# Create TFN Verifications

Create a TFN verification.

Endpoint: POST /v1/projects/{projectId}/tfnVerification
Version: 1.0
Security: BasicAuth, OAuth2

## Security:

  - `BasicAuth` (unknown)
    http basic

  - `OAuth2` (unknown)
    oauth2

## Path parameters:

  - `projectId` (string, 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](https://dashboard.sinch.com/settings/project-management).

## Request body:

  - `application/json` (unknown)
    The request body of the TFN Verification to be created

## Request fields (application/json):

  - `status` (string, required)
    The current status of the verification request.
    Enum: "STATUS_UNSPECIFIED", "WAITING", "IN_PROGRESS", "VERIFIED", "REJECTED"

  - `createdBy` (string)
    The email of the user who initiated the request.

  - `phoneNumber` (string, required)
    Toll-Free Number that is procured, hosted or in the process of hosting with Sinch. Must be in E.164 format.

  - `businessName` (string, required)
    Legal name of the business that operates the number. When an ISV submits on behalf of a client, this is the client's name, not the ISV's.

  - `businessAddress1` (string, required)

  - `businessAddress2` (string)

  - `businessCity` (string, required)

  - `businessState` (string, required)

  - `businessZipCode` (string, required)

  - `businessCountry` (string)

  - `businessContactFirstName` (string, required)

  - `businessContactLastName` (string, required)

  - `businessContactEmail` (string, required)

  - `businessContactPhone` (string, required)

  - `corporateWebsite` (string, required)

  - `messageVolume` (string, required)
    Estimate monthly volume of messages from the TFN (accepted values: 10, 100, 1000, 10000, 100000, 250000, 500000, 750000, 1000000, 5000000, 10000000+)

  - `useCase` (string, required)
    Category of the use case, fetched from the dedicated API.

  - `useCaseSummary` (string, required)
    General idea of the use case and customer.

  - `productionMessageContent` (string, required)
    Example of message content.

  - `optInWorkflowDescription` (string, required)
    Description of the opt-in workflow.

  - `optInWorkflowImageUrls` (array, required)
    Images showing the opt-in workflow.

  - `additionalInformation` (string)
    Any additional information.

  - `businessRegistrationNumber` (string, required)
    A legally recognized business registration number.

  - `businessType` (string, required)
    The type of business, selected from a list of predefined categories.
    Enum: "SOLE_PROPRIETOR", "PRIVATE_PROFIT", "PUBLIC_PROFIT", "NON_PROFIT", "GOVERNMENT"

  - `businessRegistrationCountry` (string, required)
    Country business is registered in.

  - `campaignVerifyAuthorizationToken` (string)
    Campaign tokens for customers. This is a sensitive, write-only field.

  - `businessRegistrationType` (string, required)
    The type of business registration (e.g. EIN, CBN, CRN, NEQ, Provincial Number, VAT, ACN, ABN, BRN)

  - `businessDba` (string)
    The "doing business as" (DBA) name of the business.

  - `termsAndConditionsUrl` (string, required)
    A URL to a page containing the terms and conditions.
    Example: https://www.example.com/terms

  - `privacyPolicyUrl` (string, required)
    A URL to a page containing the privacy policy.
    Example: https://www.example.com/privacy-policy

  - `isvReseller` (string)
    Name of the ISV (independent software vendor) or reseller submitting the verification on behalf of an end-client. Optional.
Only set this when you submit for a client. The business and contact fields must still describe the end-client that operates the number, not the ISV. See [Submitting as an ISV](https://developers.sinch.com/docs/10dlc-registration/api-reference/10dlc-registration/tfn-verification) for details.
    Example: ClinicSoft Inc.

  - `helpMessageResponse` (string)
    The message sent when a subscriber texts HELP to the number. It should name the business, explain how to get help, and include opt-out instructions. Optional.
    Example: Acme Corp: For help, call 1-800-555-0100 or email support@acme.com. Msg&data rates may apply. Reply STOP to opt out.

  - `tfnVerificationEmail` (string)
    Email address that receives status notifications (IN_PROGRESS, VERIFIED, REJECTED) for this TFN verification. Defaults to `createdBy` if not provided. Optional.
ISVs can set it to their own address or to the end-client's address. It can only be set when the verification is created.
    Example: notifications@clinicsoft.com

## Request examples:

  - `ISV submitting on behalf of a client` (unknown)
    The business and contact fields describe the end-client (Acme Dental Group). The ISV's own name goes only in isvReseller.

## Response 200:

  - `200` (unknown)
    A successful response.

## Response 200 fields (application/json):

  - `tfnVerificationId` (string)

## Response 400:

  - `400` (unknown)
    If the mandatory fields are not present, exceed length limits or are invalid (e.g. URLs, email addresses...)

## Response 400 fields (application/json):

  - `error` (object, required)

  - `error.code` (integer, required)
    The error code.
    Example: 400

  - `error.message` (string, required)
    The error message.
    Example: Invalid argument.

  - `error.status` (string)
    The status of the error.
    Example: INVALID_ARGUMENT

  - `error.details` (array)
    An array of objects describing the error in more detail, if applicable.

  - `error.details.type` (string)
    A more specific description of the error.
    Example: BadRequest

  - `error.details.resourceType` (string)
    The type of resource relevant to the error, if applicable.

  - `error.details.resourceName` (string)
    The name of the resource, if applicable.

  - `error.details.owner` (string)
    The owner of the resource, if applicable.

  - `error.details.description` (string)
    A description of the error, if applicable.

  - `error.details.fieldViolations` (array)
    An array of all the field violations which contributed to the error.

  - `error.details.fieldViolations.field` (string)
    The field which produced the error.
    Example: order_by

  - `error.details.fieldViolations.description` (string)
    The description of the error.
    Example: Invalid `order_by` number.

## Response 429:

  - `429` (unknown)
    Over limit

## Response 429 fields (application/json):

  - `error` (object, required)

  - `error.code` (integer, required)
    The error code.
    Example: 400

  - `error.message` (string, required)
    The error message.
    Example: Invalid argument.

  - `error.status` (string)
    The status of the error.
    Example: INVALID_ARGUMENT

  - `error.details` (array)
    An array of objects describing the error in more detail, if applicable.

  - `error.details.type` (string)
    A more specific description of the error.
    Example: BadRequest

  - `error.details.resourceType` (string)
    The type of resource relevant to the error, if applicable.

  - `error.details.resourceName` (string)
    The name of the resource, if applicable.

  - `error.details.owner` (string)
    The owner of the resource, if applicable.

  - `error.details.description` (string)
    A description of the error, if applicable.

  - `error.details.fieldViolations` (array)
    An array of all the field violations which contributed to the error.

  - `error.details.fieldViolations.field` (string)
    The field which produced the error.
    Example: order_by

  - `error.details.fieldViolations.description` (string)
    The description of the error.
    Example: Invalid `order_by` number.

