API Reference

Create Company Profile

post
https://api.cm.com/voice-companyprofilesapi/v1//companyprofiles

Create a new company profile that allows you to request new phone numbers.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Unique identifier of the Logical Account or Voice Account.

Body Params

New company profile to create.

uuid

Unique identifier of the company profile.

uuid

Unique identifier of the Logical Account or Voice Account.

string
required
length between 1 and 100

The name of the company profile. This name does not have to be equal to your company name, it's just to make
this profile more easily identifiable in our tooling. If the company has multiple branches, this profile
can be named 'Amsterdam Office' for example.

string
required
length between 1 and 100

The name of the company that will be using the phone numbers requested with this profile.

string
required
length between 1 and 100

Business register number of the company (e.g. KVK number for Dutch companies).

string
required
length between 1 and 100

First name of company’s representative that is authorized to sign contracts for the company.

string
required
length between 1 and 100

Last name of company’s representative that is authorized to sign contracts for the company

string | null

Phone number of company’s representative that is authorized to sign contracts for the company

string
required
length between 2 and 2

Country code of the company address in ISO 3166-1 alpha-2 format.

requiredFields
object | null

Depending on the country of the company address, we might require additional information that needs to be
supplied with the API call. See the Verify Required Fields endpoint documentation for more information.

string | null

Region of the company address.

string
required
length between 1 and 100

City of the company address.

string
required
length between 1 and 12

Postal code of the company address.

string
required
length between 1 and 255

Street of the company address.

string
required
length between 1 and 10

Street number of the company address.

string | null

Extra information about the street number. E.g. apartment or suite.

string
required
length between 2 and 2

The country code of the country this company profile will request numbers for. For example, if you supply
NL, you will only be able to request Dutch phone numbers with this profile.

phoneNumberTypes
array of strings
required
length ≥ 1

The types of phone numbers this profile is able to request. This can be LOCAL, NATIONAL and TOLLFREE.

phoneNumberTypes*
string
required
length between 1 and 100

First name of the person that CM.com will be able to contact regarding this profile. This contact can be about
the approval status of your profile or a request for additional information.

string
required
length between 1 and 100

Last name of the person that CM.com will be able to contact regarding this profile. This contact can be about
the approval status of your profile or a request for additional information.

emailAddresses
array of strings
required
length ≥ 1

One or more email addresses that CM.com will be able to contact regarding this profile. This contact can be about
the approval status of your profile or a request for additional information.

emailAddresses*
string | null

URL that we'll send a POST request to when the status of the request has been updated. The body of this post
request will contain the entire company profile, including the updated status.

documents
array of objects | null

List of documents that are legaly required for us to be able to request phone numbers.

documents
date-time | null

UTC DateTime on which the current profile was deleted. Can be null if the profile is still active.

string | null

The current approval status of the company profile.

string | null

Optional comment on the current approval status of the profile.

Responses

401

Unauthorized

Updated over 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago