Network Registry API
The approval request process detailed in the Network Registry guide can also be managed programmatically using the Network Registry API. This allows for automated handling of the approval process.
API Reference
The OpenAPI specification for the Network Registry API is available here.
Authentication
Authentication is based on your API Key and API Secret, which can be found in the developer dashboard.
Managing Business Profiles
You can create, retrieve and delete business profiles using the /business-profile endpoint.
The following example is a
curl -X POST "http://api-eu.vonage.com/v1/network-registry/business-profiles" \
-H "Content-Type: application/json" \
-u ${API_Key}:${API_Password} \
-d '{
"contact_role":"developer",
"name":"my business profile",
"organisation_type":"forProfitOrganisation",
"country":"ES",
"tax_number":"1234567890",
"privacy_policy_url":"https://1LThiQzd.com",
"privacy_policy_manager_email":"manager@test.com",
"dpo_email":"dpo@test.com",
"dpo_required":true,
"countries":[
"ES",
"DE"
],
"business_information":{
"address_street_1":"address 1",
"address_street_2":"address 2",
"city":"Madrid",
"province":"Madrid",
"postal_code":"28020",
"country":"ES"
},
"email_notifications_enabled":true,
"terms_and_conditions_accepted":true
}'
To modify a business profile, send a
/change-request and the ID of your business profile: curl -X PUT "http://api-eu.vonage.com/v1/network-registry/business-profiles/$BUSINESS-PROFILE-ID/change-request" \
-H "Content-Type: application/json" \
-u ${API_Key}:${API_Password} \
-d '{
"countries": [
"ES"
],
"contact_role": "A Business Profile",
"name": "A Business Profile",
"trading_name": "A Business Profile Ltd.",
"organisation_type": "For-Profit Organisation",
"tax_number": "98284687G",
"privacy_policy_url": "https://www.businessinc.com/privacy_policy",
"privacy_policy_manager_email": "privacy.manager@business.com",
"dpo_email": "dpo@business.com",
"dpo_required": true,
"terms_and_conditions_accepted": true,
"business_information": {
"address_street_1": "Main Street 5",
"address_street_2": "Extra long address",
"postal_code": "W1 5DU",
"country": "UK",
"city": "London",
"province": "City of London"
},
"email_notifications_enabled": true
}'
A full list of all operations and parameters can be found in the API Reference.
Managing Application Profiles
The /application-profiles endpoint can be used to perform all operations related to application profiles. This example sends a
curl -X POST "http://api-eu.vonage.com/v1/network-registry/application-profiles" \
-H "Content-Type: application/json" \
-u ${API_Key}:${API_Password} \
-d '{
"business_profile_id": "string",
"name": "Network Application Profile",
"description": "This is an example use case for Fraud Prevention",
"category_id": "finance",
"network_apis": [
{
"network_api_id": "sim-swap",
"purpose_ids": [
"FraudPreventionAndDetection"
]
}
],
"terms_and_conditions_accepted": true,
"infrastructure_locations": [
"ES"
}'
A full list of all operations and parameters can be found in the API Reference.
Other Operations
The /catalogue endpoint can be used to list useful resources such as countries, categories organization types or purposes:
- GET
/v1/network-registry/catalogue/countries: List supported countries - GET
/v1/network-registry/catalogue/organisation-types: List supported organization types - GET
/v1/network-registry/catalogue/categories: List supported categories - GET
/v1/network-registry/catalogue/network-apis: List supported Network Features - GET
/v1/network-registry/catalogue/purposes: List supported purposes