Network Registry

To use the Vonage Network APIs in production, you will need to register for approval to access Operator networks from one or more applications.

To streamline this process for you, Vonage manages registration with numerous operator partners behind the scenes for all supported Network APIs, in any country made available by Vonage. This process is dependent on each Operator’s approval, which may come through to the Vonage Network Registry at different times.

The Process

To start the Vonage Network Registry process, you must have a Vonage account; if you do not already have one, you can register for an account here.

Once you're logged in, go to the Build & Manage section and click on Network Registry to get started:

There are three main steps to complete your registration for the Network APIs:

Add a business profile: Tell us a little about the organization that owns the application.
Create a Network Application profile: Select the Network APIs you wish to use, describe your use case, and submit for approval.
Connect your Vonage application: Link your profile to a new or existing Vonage Application for authentication.

Add Business Profile

A Business Profile helps Vonage and its operator partners know which organization owns each application using Network APIs.

To ensure your registration is routed to the correct Operators, you'll first need to select where service is required by choosing from the list of available countries. Your registration will be shared with available Operators in each country you select. Available countries and Operators can be seen here.

Next, complete a business profile by providing more information about the organization that owns the applications. When filling out this section, you'll need the following information:

Role - the functional role you perform for, or your relationship with, the organization.
Business Name - the name of the legal entity that owns the applications that will use Vonage Network APIs.
Trading Name - If different, include the name the organization trades under.
Organization type - select the most appropriate type from the dropdown list.
Business registered address / country - the address and country where the organization is registered.
Business Tax number - the tax reference for the organization in the registered country will be used by Vonage and Operators to validate the organization.
Privacy policy URL - Vonage and its Operator partners require that anyone using Network APIs has a privacy policy, publicly available on the Internet - provide the address for the organization’s policy.
Privacy Policy Manager’s email address - include an email address that can be used for any questions relating to the privacy policy.
Data Protection Officer’s (DPO) email address - if required by law to have a DPO, include an email contact if it differs from that of the Privacy Policy Manager.
Business Location - enter the registered address of the organization.

Once submitted you will see a summary of your Business Profile, through which you can view and track the status of your registration. You may receive email notifications when the status of your registration changes; notification settings can be changed here.

Create a Network Application Profile

Application profiles are used to enable one or more Network APIs, describe a use case, and submit to Operators for approval. From the Business profile of the application owner, click the "Add application profile" button.

When filling out this section, you'll need the following information:

Profile name - give the application a name to easily identify it.
Category - select an application category from the drop down list.
Network APIs - select one or more Network APIs that you may want to use.
Purpose - for each Network API selected, confirm the purpose from the drop down list, e.g. “Fraud Prevention and Detection”.
Infrastructure locations - select all countries where you may process personal data related to the use of requested Network APIs.
Use case description - describe your application from a consumer's point of view. Include an explanation of how the selected Network APIs will help the application meet the selected purpose.

Once submitted, you will see an updated summary, including Network Application profiles. You may receive email notifications when your application status changes; notification settings can be changed here.

Connect your Vonage Application

Once your registration is approved by at least one Operator, you can link it to one or more Vonage Applications to start using Network APIs. The Vonage application contains the credentials needed to make API calls.

Navigate to the Applications page on the dashboard and click 'Create a new application', then follow these steps:

Name - Give a name to your application.
Authentication - Either provide your own keys, or click on "Generate public and private key" to generate the keys needed during the authentication process; a new public key will appear on the text box, while your browser will automatically download the private key.
Under the capabilities section, enable "Network Registry" and select the access type required: Playground or Production.
- For more information about testing from the Vonage Network API Playground, see here.
- For Production access, select the business profile and the application profile you created in the previous steps.

Enable Network APIs capability in the Vonage application

You may be prompted to configure options depending on the Network APIs included in your registration.

Managing Your Registrations

Registration Status

To see the status of your Network API Registration, navigate to Vonage API Dashboard→Network Registry.

Select a Business Profile and expand the Application profile to show status from each of Vonage’s operator partners in the countries you selected.

There are a number of states that registration components can be in, which can vary between components and between each of Vonage’s operator partners at any given time. Expanded views will include a summary description of each state:

PENDING: received, pending approval
NOT-SUBMITTED: not yet submitted to Operator
PROVISIONING: submitted to Operator
ACCEPTED: accepted by Operator
PARTIALLY-ACCEPTED: accepted by some Operators, rejected by others
REJECTED: rejected by Operator
FAILED*: submission to Operator unsuccessful

* Failed submissions will be retried by Vonage. You do not need to notify us unless the problem persists.

In a Production mode, Network API requests will only be forwarded to an Operator if sent from an Application linked to a profile that has been accepted by that Operator.

Notifications

When a Network API Registration is first submitted, you will be subscribed to status change notifications. At any time, you can unsubscribe, or change notification settings by navigating to Vonage API Dashboard→API Settings→Notifications

Support

For help with Network APIs, including this registration process, see the API Support Help Center.

Next Steps

Once you've registered and have been approved, you are ready to start using the APIs!