Creating a company profile via API

To create a complete company profile, you need to gather some information beforehand:

  • Do the phone number types and the country you want to use require any additional documents?
  • Do the phone number types and the country you want to use impose any restrictions on how you intend to use your numbers?
  • Does the country of your company's address require any additional information?

📘

Creating a profile without supplying additional information

It’s possible to create a new company profile without providing the additional required information, such as documents, initially. This information can be supplied at any time. However, please note that we cannot begin the approval process until your profile is complete.

Checking requirements

Based on the phone number types and country of the phone numbers you want to request, it’s possible that we require extra information. You can check these requirements using the Get Country Requirements endpoint with the country code of the country code of the country from which you want to operate phone numbers.

  • All requirements in the response with type = 1 represent documents that must be uploaded to the Voice Documents API. For more information on how to upload these documents, please see the Uploading documents paragraph below.
  • All requirements in the response with type = 2 represent requirements/restrictions for the company that will be using the phone numbers requested with this company profile. You don’t need to provide any additional information for these requirements, but it’s important to take note of these.
  • All requirements in the response with type = 3 represent requirements/restrictions for the phone number requests that will be created by this company profile. You don’t need to provide any additional information for these requirements, but it’s important to take note of these.

If the response is an empty list, the given country code and number types have no additional requirements, and you don't need to upload any documents for your company profile.

Uploading documents

Due to laws, rules, and regulations, some countries require specific documentation to be checked and verified before a company can request and operate phone numbers in their country. To supply these documents, please upload them to the Voice Documents API using the Upload Documents endpoint. In response, you will receive a Document GUID. Please save this GUID, as you will need to append it to the request when creating a new company profile later.

Checking required fields

For some countries, we require additional information about the company requesting or operating phone numbers. This can include details such as national tax numbers. To check if your company profile requires any of these additional fields, you can call the Get Required Fields endpoint with the country code of your company's address.

In the response to this request, you will find a list of required fields, including example values with the expected formatting. If the response is an empty list, we do not require any additional fields for the given country code.

To validate if the values provided for the required fields are correct before creating a new profile, you can use the Validate Required Fields endpoint.

Creating your company profile

After checking if your company profile requires any additional information, you can create your new profile using the Create Company Profile endpoint. If your profile requires any of the previously checked required fields, you can supply them in the requiredFields property as follows:

"requiredFields": {
	"required_field_key": "required_field_value"
}

If your profile requires any documents to be uploaded, after you've uploaded them to the Voice Documents API as described earlier, you can add them to the profile as follows:

"documents": [{
	"requirementKey": "requirement_key_value",
	"documentGuid": "Place GUID as response from the Documents API here"
}]

After your profile has been created, it undergoes a verification process to ensure all provided information is correct. You can track the status of this process through the statusKey property in the response object. Additionally, you will receive updates on any status changes via the provided email addresses and callback URL. For a comprehensive list of all possible statuses your profile can have, please refer to the Get Company Profile Statuses endpoint.

Once your profile reaches the status approved, you can begin using your company profile to create new phone number requests.