{ "openapi": "3.0.1", "info": { "title": "Network Registry", "description": "The Vonage Network Registry handles pre-registration and approval with multiple\nMobile Operators (also knows as Communication Service Providers or CSPs), which is required before using\nNetwork APIs. Note that Operator responses to registration requests are asynchronous and may\nbe received by the Vonage Network Registry at different times.\n", "version": "v1" }, "servers": [ { "url": "https://api-eu.vonage.com", "description": "Server url." } ], "security": [ { "BasicAuth": [] } ], "tags": [ { "name": "Business Profile", "description": "Business Profiles are used to define the organization, or legal entity,\nrequesting access to Network APIs and will be shared with CSPs in the countries\nincluded with the business profile." }, { "name": "Application Profile", "description": "Application profiles are used to define a specific use case, including which\nNetwork APIs are required and the purpose they will be used for, and will be\nshared with CSPs in the countries included with the associated business profile." }, { "name": "Catalogue", "description": "These endpoints are used to operate with different resources such as countries, \ncategories organization types or purposes." } ], "paths": { "/v1/network-registry/business-profiles": { "post": { "summary": "Create a new network Business Profile registration.", "description": "Create a new network Business Profile registration. There is a limit of 50 business profiles per account.", "operationId": "createBusinessProfile", "tags": [ "Business Profile" ], "requestBody": { "description": "The network Business Profile registration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessProfile" } } }, "required": true }, "responses": { "201": { "description": "The created network Business Profile registration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessProfile" } } } }, "409": { "description": "The Business Profile cannot be created", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "MaxNumberOfProfilesReached": { "$ref": "#/components/examples/MaxNumberOfCreatedProfilesReachedExample" }, "InvalidEntity": { "$ref": "#/components/examples/InvalidEntityExample" }, "UnsupportedCountry": { "$ref": "#/components/examples/UnsupportedCountryExample" } } } } }, "422": { "description": "Unprocessable entity.", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/InvalidParametersResponse" } ] }, "examples": { "BadRequest": { "$ref": "#/components/examples/BadRequestExample" }, "InvalidParameter": { "$ref": "#/components/examples/InvalidParametersExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } }, "get": { "summary": "List network Business Profile registrations.", "operationId": "listBusinessProfile", "tags": [ "Business Profile" ], "parameters": [ { "$ref": "#/components/parameters/next" }, { "$ref": "#/components/parameters/limit" }, { "name": "shared", "in": "query", "required": false, "description": "Flag of shared profiles.", "example": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "The list of matched network Business Profile registrations.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginatedResult" }, { "type": "object", "properties": { "_embedded": { "type": "object", "required": [ "business_profiles" ], "properties": { "business_profiles": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessProfile" } } } } } } ] } } } }, "422": { "description": "Unprocessable entity.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/InvalidParametersResponse" }, "examples": { "InvalidParameter": { "$ref": "#/components/examples/InvalidParametersExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/business-profiles/{id}": { "parameters": [ { "$ref": "#/components/parameters/business_profile_id" } ], "get": { "summary": "Get a network Business Profile registration.", "operationId": "getBusinessProfile", "tags": [ "Business Profile" ], "responses": { "200": { "description": "The network Business Profile registration with the given id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessProfile" } } } }, "404": { "description": "No network Business Profile registrations found belonging to given account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } }, "delete": { "summary": "Delete a network Business Profile registration.", "operationId": "deleteBusinessProfile", "description": "Request the deletion of the network Business Profile registration and all its dependant Network Applications.\n", "tags": [ "Business Profile" ], "responses": { "202": { "description": "The network Business Profile has been marked for deletion." }, "404": { "description": "No network Business Profile registration found belonging to given account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "409": { "description": "The network Business Profile registration cannot be removed.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CanNotDelete": { "$ref": "#/components/examples/CanNotDeleteEntityExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/business-profiles/{id}/notification/dismiss": { "parameters": [ { "$ref": "#/components/parameters/business_profile_id" } ], "post": { "summary": "Dismiss the Custom Notification", "operationId": "dismissBusinessProfileNotification", "description": "Marks the Custom Notification as dismissed.\n", "tags": [ "Business Profile" ], "responses": { "202": { "description": "The Custom Notification is marked as dismissed." }, "404": { "description": "No network Business Profile registration found belonging to given account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/business-profiles/{id}/undelete": { "parameters": [ { "$ref": "#/components/parameters/business_profile_id" } ], "post": { "summary": "Undelete a network Business Profile registration.", "operationId": "undeleteBusinessProfile", "description": "Request the undeletion of the network Business Profile registration and all its dependant Network Applications.\n", "tags": [ "Business Profile" ], "responses": { "202": { "description": "The network Business Profile has been undeleted." }, "404": { "description": "No network Business Profile registration found belonging to given account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "409": { "description": "The network Business Profile registration cannot be undeleted.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "MaxNumberOfProfilesReached": { "$ref": "#/components/examples/MaxNumberOfCreatedProfilesReachedExample" }, "CanNotUndelete": { "$ref": "#/components/examples/CanNotUndeleteEntityExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/business-profiles/{id}/csps": { "parameters": [ { "$ref": "#/components/parameters/any_business_profile_id" } ], "get": { "summary": "Detailed information of Business Profile registration status per CSP.\n", "operationId": "getInformationBusinessProfileStatus", "tags": [ "Business Profile" ], "parameters": [ { "$ref": "#/components/parameters/next" }, { "$ref": "#/components/parameters/limit" }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/BusinessProfileCspStatusValues" } } ], "responses": { "200": { "description": "A paginated view of the Business Profile registration status per CSP", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginatedResult" }, { "type": "object", "properties": { "_embedded": { "type": "object", "required": [ "business_profile_csp_statuses" ], "properties": { "business_profile_csp_statuses": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessProfileCspStatus" } } } } } } ] } } } }, "404": { "description": "No network Business Profile registration found belonging to given account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "422": { "description": "Unprocessable entity.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/InvalidParametersResponse" }, "examples": { "InvalidParameter": { "$ref": "#/components/examples/InvalidParametersExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/business-profiles/{id}/csps/{csp_id}": { "parameters": [ { "$ref": "#/components/parameters/business_profile_id" }, { "$ref": "#/components/parameters/csp_id" } ], "get": { "summary": "Detailed information of Business Profile registration status for a given CSP.", "operationId": "getInformationBusinessProfileStatusCSP", "tags": [ "Business Profile" ], "responses": { "200": { "description": "The Business Profile registration status for the given CSP", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessProfileCspStatus" } } } }, "404": { "description": "No network Business Profile registration for given CSP found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/business-profiles/{id}/status": { "parameters": [ { "$ref": "#/components/parameters/business_profile_id" } ] }, "/v1/network-registry/business-profiles/{id}/shared": { "get": { "description": "Get a list of accounts with which your network Business Profile has been shared", "summary": "Get a list of accounts Business Profile shared with.", "operationId": "getAccountsBusinessProfileSharedWith", "parameters": [ { "$ref": "#/components/parameters/business_profile_id" }, { "$ref": "#/components/parameters/next" }, { "$ref": "#/components/parameters/limit" } ], "tags": [ "Business Profile" ], "responses": { "202": { "description": "A share of network Business Profile", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginatedResult" }, { "type": "object", "properties": { "_embedded": { "type": "object", "required": [ "account_ids" ], "properties": { "account_ids": { "type": "array", "items": { "$ref": "#/components/schemas/Share" } } } } } } ] } } } }, "404": { "description": "The share of network Business Profile not found or given account id has no permission to access it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "422": { "description": "Unprocessable entity.", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/InvalidParametersResponse" } ] }, "examples": { "BadRequest": { "$ref": "#/components/examples/BadRequestExample" }, "InvalidParameter": { "$ref": "#/components/examples/InvalidParametersExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/application-profiles": { "get": { "summary": "List network Application Profile registrations.\n", "operationId": "getApplicationProfiles", "tags": [ "Application Profile" ], "parameters": [ { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/ApplicationProfileStatusValues" } }, { "name": "business_profile_id", "in": "query", "required": false, "description": "Id of a Business Profile.", "example": "2hothFWw2ssb3y3lhh5Fu3tzfqV", "schema": { "type": "string" } }, { "name": "shared", "in": "query", "required": false, "description": "Flag of shared profiles.", "example": true, "schema": { "type": "boolean" } }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/next" } ], "responses": { "200": { "description": "The list of matched network Application Profiles of the given Account.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginatedResult" }, { "type": "object", "properties": { "_embedded": { "type": "object", "required": [ "application_profiles" ], "properties": { "application_profiles": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationProfile" } } } } } } ] } } } }, "422": { "description": "Unprocessable entity.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/InvalidParametersResponse" }, "examples": { "InvalidParameter": { "$ref": "#/components/examples/InvalidParametersExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } }, "post": { "summary": "Create a new network Application Profile.", "description": "Create a new network Application Profile. There is a limit of 50 application profiles per account.", "operationId": "createApplicationProfile", "tags": [ "Application Profile" ], "requestBody": { "description": "The network Application Profile registration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationProfile" } } }, "required": true }, "responses": { "201": { "description": "The created network Application Profile.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationProfile" } } } }, "409": { "description": "The Application Profile cannot be created.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "MaxNumberOfProfilesReached": { "$ref": "#/components/examples/MaxNumberOfCreatedProfilesReachedExample" }, "BusinessProfileNotFound": { "$ref": "#/components/examples/BusinessProfileNotFoundExample" }, "UnsupportedNetworkApi": { "$ref": "#/components/examples/UnsupportedNetworkApiExample" }, "InvalidEntity": { "$ref": "#/components/examples/InvalidEntityExample" } } } } }, "422": { "description": "Unprocessable entity.", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/InvalidParametersResponse" } ] }, "examples": { "BadRequest": { "$ref": "#/components/examples/BadRequestExample" }, "InvalidParameter": { "$ref": "#/components/examples/InvalidParametersExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/application-profiles/{id}": { "get": { "summary": "Get network Application Profile.", "operationId": "getApplicationProfile", "description": "Get network Application Profile", "parameters": [ { "$ref": "#/components/parameters/application_profile_id" } ], "tags": [ "Application Profile" ], "responses": { "200": { "description": "A network Application Profile.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationProfile" } } } }, "404": { "description": "The network Application Profile not found or given account id has no permission to access it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } }, "delete": { "description": "Delete network Application Profile", "summary": "Delete a network Application Profile.", "operationId": "deleteApplicationProfile", "parameters": [ { "$ref": "#/components/parameters/application_profile_id" } ], "tags": [ "Application Profile" ], "responses": { "202": { "description": "The application profile has been marked for deletion." }, "404": { "description": "The network Application Profile not found or given account id has no permission to access it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "409": { "description": "The network Application Profile registration cannot be removed.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CanNotDelete": { "$ref": "#/components/examples/CanNotDeleteEntityExample" }, "CannotDeleteDueToLinkedApplication": { "$ref": "#/components/examples/CanNotDeleteDueToLinkedApplication" }, "CannotDeleteDueToSharedLinkedApplication": { "$ref": "#/components/examples/CanNotDeleteDueToSharedLinkedApplication" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/application-profiles/{id}/notification/dismiss": { "parameters": [ { "$ref": "#/components/parameters/application_profile_id" } ], "post": { "summary": "Dismiss the Custom Notification", "operationId": "dismissApplicationProfileNotification", "description": "Marks the Custom Notification as dismissed.\n", "tags": [ "Application Profile" ], "responses": { "202": { "description": "The Custom Notification is marked as dismissed." }, "404": { "description": "No network Application Profile registration found belonging to given account.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/application-profiles/{id}/undelete": { "post": { "description": "Undelete network Application Profile", "summary": "Undelete network Application Profile.", "operationId": "undeleteApplicationProfile", "parameters": [ { "$ref": "#/components/parameters/application_profile_id" } ], "tags": [ "Application Profile" ], "responses": { "202": { "description": "The application profile has been undeleted." }, "404": { "description": "The network Application Profile not found or given account id has no permission to access it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "409": { "description": "The network Application Profile registration cannot be undeleted.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "MaxNumberOfProfilesReached": { "$ref": "#/components/examples/MaxNumberOfCreatedProfilesReachedExample" }, "CanNotUndelete": { "$ref": "#/components/examples/CanNotUndeleteEntityExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/application-profiles/{id}/csps": { "parameters": [ { "$ref": "#/components/parameters/any_application_profile_id" } ], "get": { "summary": "Detailed information of Application Profile registration status per CSP.\n", "operationId": "getApplicationProfileAllCSPs", "tags": [ "Application Profile" ], "parameters": [ { "$ref": "#/components/parameters/next" }, { "$ref": "#/components/parameters/limit" }, { "name": "plmn_id", "in": "query", "required": false, "description": "Filter list of CSP statuses by PLMN id.", "example": "mcc=213;mnc=07", "schema": { "type": "string", "minLength": 14, "maxLength": 15 } }, { "name": "status", "in": "query", "description": "Filter list of the CSP statuses by status.", "schema": { "$ref": "#/components/schemas/ApplicationProfileCspStatusValues" } }, { "name": "csp_id", "in": "query", "required": false, "description": "Filter list of CSP statuses by csp_id", "example": "telefonica_es", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A paginated view of the Application Profile registration status per CSP", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginatedResult" }, { "type": "object", "properties": { "_embedded": { "type": "object", "required": [ "application_profile_csp_statuses" ], "properties": { "application_profile_csp_statuses": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationProfileCspStatus" } } } } } } ] } } } }, "404": { "description": "The network Application Profile not found or given account id has no permission to access it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" }, "SandboxTestApplicationNotFound": { "$ref": "#/components/examples/SandboxTestApplicationNotFoundExample" } } } } }, "422": { "description": "Unprocessable entity.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/InvalidParametersResponse" }, "examples": { "InvalidParameter": { "$ref": "#/components/examples/InvalidParametersExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/application-profiles/{id}/shared": { "post": { "summary": "Share network Application Profile.", "operationId": "shareApplicationProfile", "description": "Share network Application Profile", "parameters": [ { "$ref": "#/components/parameters/application_profile_id" } ], "tags": [ "Application Profile" ], "requestBody": { "description": "The network Application Profile share.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Share" }, "examples": { "Share": { "$ref": "#/components/examples/ShareExample" } } } }, "required": true }, "responses": { "202": { "description": "A network Application Profile shared." }, "404": { "description": "The network Application Profile not found or given account id has no permission to access it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "409": { "description": "The network Application Profile cannot be shared", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "MaxNumberOfProfilesReached": { "$ref": "#/components/examples/MaxNumberOfSharedProfilesReachedExample" }, "CanNotShare": { "$ref": "#/components/examples/CanNotShareEntityExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } }, "get": { "description": "Get a list of accounts with which your network Application Profile has been shared", "summary": "Get a list of accounts network Application Profile shared with.", "operationId": "getAccountsApplicationProfileSharedWith", "parameters": [ { "$ref": "#/components/parameters/application_profile_id" }, { "$ref": "#/components/parameters/next" }, { "$ref": "#/components/parameters/limit" } ], "tags": [ "Application Profile" ], "responses": { "202": { "description": "A share of network Application Profile", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginatedResult" }, { "type": "object", "properties": { "_embedded": { "type": "object", "required": [ "account_ids" ], "properties": { "account_ids": { "type": "array", "items": { "$ref": "#/components/schemas/Share" } } } } } } ] } } } }, "404": { "description": "The share of network Application Profile not found or given account id has no permission to access it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "422": { "description": "Unprocessable entity.", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/InvalidParametersResponse" } ] }, "examples": { "BadRequest": { "$ref": "#/components/examples/BadRequestExample" }, "InvalidParameter": { "$ref": "#/components/examples/InvalidParametersExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/application-profiles/{id}/shared/{account_id}": { "delete": { "description": "Unshare network Application Profile", "summary": "Unshare network Application Profile.", "operationId": "unshareApplicationProfile", "parameters": [ { "$ref": "#/components/parameters/application_profile_id" }, { "$ref": "#/components/parameters/account_id_path_param" } ], "tags": [ "Application Profile" ], "responses": { "202": { "description": "The application profile has been unshared." }, "404": { "description": "The network Application Profile not found or given account id has no permission to access it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "409": { "description": "The network Application Profile cannot be unshared.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "CanNotUnshare": { "$ref": "#/components/examples/CanNotUnshareEntityExample" }, "CanNotUnshareDueToLinkedApplication": { "$ref": "#/components/examples/CanNotUnshareDueToEntityExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/application-profiles/{id}/linked-applications": { "get": { "description": "Get a list of linked Vonage Applications under the Application profile", "summary": "Get a list of linked Vonage Applications", "operationId": "getLinkedVonageApplications", "parameters": [ { "$ref": "#/components/parameters/application_profile_id" } ], "tags": [ "Application Profile" ], "responses": { "200": { "description": "List of linked Vonage Applications under application profile", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginatedResult" }, { "type": "object", "properties": { "_embedded": { "type": "object", "required": [ "linked_applications" ], "properties": { "linked_applications": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedApplication" } } } } } } ] } } } }, "404": { "description": "The Application Profile not found or given account id has no permission to access it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "422": { "description": "Unprocessable entity.", "content": { "application/problem+json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/InvalidParametersResponse" } ] }, "examples": { "BadRequest": { "$ref": "#/components/examples/BadRequestExample" }, "InvalidParameter": { "$ref": "#/components/examples/InvalidParametersExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/application-profiles/{id}/csps/{csp_id}": { "parameters": [ { "$ref": "#/components/parameters/application_profile_id" }, { "$ref": "#/components/parameters/csp_id" } ], "get": { "summary": "Detailed information of Application Profile registration status for the given CSP.", "operationId": "getApplicationProfileCSP", "tags": [ "Application Profile" ], "responses": { "200": { "description": "The Application Profile registration status for the given CSP", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationProfileCspStatus" } } } }, "404": { "description": "No Application Profile registration for given CSP found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/business-profiles/{id}/change-request": { "parameters": [ { "$ref": "#/components/parameters/business_profile_id" } ], "put": { "summary": "Create or update a change request", "operationId": "createChangeRequest", "description": "The operation will create a new change request for the given business profile if there is no existing one. It will update the existing one if there is a pending change request present.\n", "tags": [ "Business Profile" ], "requestBody": { "description": "The fields of the network Business Profile registration to be updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessProfileChangeRequest" } } }, "required": true }, "responses": { "202": { "description": "An existing change request has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessProfile" }, "examples": { "BusinessProfileWithChangeRequest": { "$ref": "#/components/examples/BusinessProfileChangeRequestExample" } } } } }, "404": { "description": "No Business Profile Change Request found belonging to given profile.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "409": { "description": "The Business Profile Change Request cannot be created", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "title": "Conflict", "type": "https://developer.vonage.com/api-errors#conflict", "detail": "DPO email is mandatory if DPO required field is checked.", "instance": "06032957-99ce-41ee-978b-9a390cd5a89" } } } }, "422": { "description": "Unprocessable entity.", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/InvalidParametersResponse" } ] }, "examples": { "BadRequest": { "$ref": "#/components/examples/BadRequestExample" }, "InvalidParameter": { "$ref": "#/components/examples/InvalidParametersExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } }, "delete": { "summary": "Delete Business Profile Change Request", "operationId": "deleteChangeRequest", "description": "Deletes an existing Business Profile Change Request, returns 404 if no such change request is present\n", "tags": [ "Business Profile" ], "responses": { "202": { "description": "The Business Profile Change Request has been deleted" }, "404": { "description": "No Business Profile Change Request found belonging to given profile.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/business-profiles/{id}/linked-applications": { "get": { "description": "Get a list of linked Vonage Applications under the Business profile", "summary": "Get a list of linked Vonage Applications", "operationId": "getLinkedVonageApplicationsByBusinessProfile", "parameters": [ { "$ref": "#/components/parameters/business_profile_id" } ], "tags": [ "Business Profile" ], "responses": { "200": { "description": "List of linked Vonage Applications under the business profile", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginatedResult" }, { "type": "object", "properties": { "_embedded": { "type": "object", "required": [ "linked_applications" ], "properties": { "linked_applications": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedApplication" } } } } } } ] } } } }, "404": { "description": "The Business Profile not found or given account id has no permission to access it.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "422": { "description": "Unprocessable entity.", "content": { "application/problem+json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "$ref": "#/components/schemas/InvalidParametersResponse" } ] }, "examples": { "BadRequest": { "$ref": "#/components/examples/BadRequestExample" }, "InvalidParameter": { "$ref": "#/components/examples/InvalidParametersExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/catalogue/countries": { "get": { "summary": "List supported countries.", "operationId": "getCountries", "tags": [ "Catalogue" ], "parameters": [ { "$ref": "#/components/parameters/next" } ], "responses": { "200": { "description": "The list of supported countries.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginatedResult" }, { "type": "object", "properties": { "_embedded": { "type": "object", "required": [ "countries" ], "properties": { "countries": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } } } } } ] } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/catalogue/organisation-types": { "get": { "summary": "List supported Organisation Types.", "operationId": "getOrganisationTypes", "tags": [ "Catalogue" ], "parameters": [ { "$ref": "#/components/parameters/next" } ], "responses": { "200": { "description": "The list of supported Organisation Types.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginatedResult" }, { "type": "object", "properties": { "_embedded": { "type": "object", "required": [ "organisation_types" ], "properties": { "organisation_types": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationType" } } } } } } ] } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/catalogue/categories": { "get": { "summary": "List supported Categories.", "operationId": "getCategories", "tags": [ "Catalogue" ], "parameters": [ { "$ref": "#/components/parameters/next" } ], "responses": { "200": { "description": "The list of supported Categories.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginatedResult" }, { "type": "object", "properties": { "_embedded": { "type": "object", "required": [ "categories" ], "properties": { "categories": { "type": "array", "items": { "$ref": "#/components/schemas/Category" } } } } } } ] } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/catalogue/csps": { "get": { "summary": "List Communications Service Providers (CSP).", "operationId": "getCSPs", "tags": [ "Catalogue" ], "parameters": [ { "name": "countries", "in": "query", "required": false, "description": "Comma separated list of ISO 3166 country short codes to filter.", "example": "ES,DE", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CountryCode" } }, "style": "form", "explode": false }, { "name": "all", "in": "query", "required": false, "description": "If enabled, list all the CSPs defined in the platform", "example": true, "schema": { "type": "boolean" } }, { "$ref": "#/components/parameters/next" } ], "responses": { "200": { "description": "The list of matched supported CSPs.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginatedResult" }, { "type": "object", "properties": { "_embedded": { "type": "object", "required": [ "csps" ], "properties": { "csps": { "type": "array", "items": { "$ref": "#/components/schemas/Csp" } } } } } } ] } } } }, "409": { "description": "Any of the given country short codes is not supported.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "UnsupportedCountry": { "$ref": "#/components/examples/UnsupportedCountryExample" } } } } }, "422": { "description": "Unprocessable entity.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/InvalidParametersResponse" }, "examples": { "InvalidParameter": { "$ref": "#/components/examples/InvalidParametersExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/catalogue/network-apis": { "get": { "summary": "List supported Network APIs.", "operationId": "getNetworkAPIs", "tags": [ "Catalogue" ], "parameters": [ { "name": "countries", "in": "query", "required": false, "description": "Comma separated list of ISO 3166 country short codes to filter.", "example": "ES,DE", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Country" } } }, { "name": "all", "in": "query", "required": false, "description": "If enabled, list all the Network APIs defined in the platform", "example": true, "schema": { "type": "boolean" } }, { "$ref": "#/components/parameters/next" } ], "responses": { "200": { "description": "The list of supported Network APIs.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginatedResult" }, { "type": "object", "properties": { "_embedded": { "type": "object", "required": [ "network_apis" ], "properties": { "network_apis": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkAPI" } } } } } } ] } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/catalogue/purposes": { "get": { "summary": "List supported Purposes.", "operationId": "getSupportedPurposes", "tags": [ "Catalogue" ], "parameters": [ { "name": "network-apis", "in": "query", "required": false, "description": "Comma separated list of Network APIs ids to filter.", "example": "sim-swap,number-verification", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/next" } ], "responses": { "200": { "description": "The list of supported Purposes.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginatedResult" }, { "type": "object", "properties": { "_embedded": { "type": "object", "required": [ "purposes" ], "properties": { "purposes": { "type": "array", "items": { "$ref": "#/components/schemas/Purpose" } } } } } } ] } } } }, "409": { "description": "Any of the given Network APIs ids is not supported.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "UnsupportedNetworkApi": { "$ref": "#/components/examples/UnsupportedNetworkApiExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/catalogue/vetting-levels": { "get": { "summary": "List supported Vetting levels.", "operationId": "getVettingLevels", "description": "Vetting levels define the different requirements needed for an independent verification of the business profile (for example, requiring more information during the creation of the business profile).", "tags": [ "Catalogue" ], "parameters": [ { "$ref": "#/components/parameters/next" } ], "responses": { "200": { "description": "The list of supported Vetting Levels.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginatedResult" }, { "type": "object", "properties": { "_embedded": { "type": "object", "required": [ "vetting_levels" ], "properties": { "vetting_levels": { "type": "array", "items": { "$ref": "#/components/schemas/VettingLevel" } } } } } } ] } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/catalogue/vetting-levels/{id}": { "parameters": [ { "$ref": "#/components/parameters/vetting_level_id" } ], "get": { "summary": "Get a Vetting Level.", "operationId": "loadVettingLevel", "tags": [ "Catalogue" ], "responses": { "200": { "description": "The Vetting Level with the given id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VettingLevel" } } } }, "404": { "description": "No Vetting Level found belonging with the given id.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/catalogue/terms-and-conditions": { "get": { "summary": "List supported Terms and Conditions.", "operationId": "getTermsAndConditions", "tags": [ "Catalogue" ], "parameters": [ { "$ref": "#/components/parameters/next" } ], "responses": { "200": { "description": "The list of supported Terms and Conditions.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PaginatedResult" }, { "type": "object", "properties": { "_embedded": { "type": "object", "required": [ "terms_and_conditions" ], "properties": { "terms_and_conditions": { "type": "array", "items": { "$ref": "#/components/schemas/TermsAndConditions" } } } } } } ] } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } }, "/v1/network-registry/catalogue/terms-and-conditions/{id}": { "parameters": [ { "$ref": "#/components/parameters/terms_and_conditions_id" } ], "get": { "summary": "Get Terms and Conditions.", "operationId": "loadTermsAndConditions", "tags": [ "Catalogue" ], "responses": { "200": { "description": "The Terms and Conditions with the given id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsAndConditions" } } } }, "404": { "description": "No Terms and Conditions found belonging with the given id.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "NotFound": { "$ref": "#/components/examples/NotFoundExample" } } } } }, "500": { "description": "Internal / provider error.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "InternalError": { "$ref": "#/components/examples/InternalErrorExample" } } } } } } } } }, "components": { "securitySchemes": { "BasicAuth": { "type": "http", "scheme": "basic" } }, "parameters": { "next": { "name": "next", "in": "query", "required": false, "description": "Opaque token for retrieving next results page.", "example": "d3b108c616804f52b97d33d6ddbff2d8", "schema": { "type": "string" } }, "limit": { "name": "limit", "in": "query", "required": false, "description": "Limit the number of items in the result page.", "example": 100, "schema": { "type": "number", "minimum": 1, "maximum": 100 } }, "business_profile_id": { "name": "id", "in": "path", "required": true, "description": "The network Business Profile id.", "example": "2hothFWw2ssb3y3lhh5Fu3tzfqV", "schema": { "type": "string" } }, "any_business_profile_id": { "name": "id", "in": "path", "required": true, "description": "Business Profile ID, or the literal \"*\" for ALL the Business Profiles\n", "examples": { "regular": { "value": "2hothFWw2ssb3y3lhh5Fu3tzfqV", "summary": "The Business Profile Id" }, "wildcard": { "value": "*", "summary": "Search the statuses of all the Business Profiles" } }, "schema": { "type": "string" } }, "csp_id": { "name": "csp_id", "in": "path", "required": true, "description": "The CSP identifier.", "example": "telefonica_es", "schema": { "type": "string" } }, "application_profile_id": { "name": "id", "in": "path", "required": true, "description": "Network Application Profile ID", "example": "2hotg2Wzoy65nG6VKNaap4VFQvC", "schema": { "type": "string" } }, "any_application_profile_id": { "name": "id", "in": "path", "required": true, "description": "Network Application Profile ID, or the literal \"*\" for ALL the Applications\n", "examples": { "regular": { "value": "2hotg2Wzoy65nG6VKNaap4VFQvC", "summary": "The Application Profile Id" }, "wildcard": { "value": "*", "summary": "Search the statuses of all the Applications" } }, "schema": { "type": "string" } }, "account_id_path_param": { "name": "account_id", "in": "path", "required": true, "description": "Id of the Vonage Account.\n", "example": "e2eb1844", "schema": { "type": "string" } }, "vetting_level_id": { "name": "id", "in": "path", "required": true, "description": "The Vetting Level identifier.", "example": "standard", "schema": { "type": "string" } }, "terms_and_conditions_id": { "name": "id", "in": "path", "required": true, "description": "The Terms and Conditions identifier.", "example": "general", "schema": { "type": "string" } } }, "schemas": { "PaginatedResultHref": { "type": "object", "required": [ "href" ], "properties": { "href": { "description": "URL pointing to some resource(s).", "type": "string", "maxLength": 4096, "example": "https://example.com/resource?next=19284743" } } }, "PaginatedResult": { "type": "object", "required": [ "_links", "_embedded" ], "properties": { "_links": { "type": "object", "description": "Pagination info.", "required": [ "self" ], "properties": { "self": { "$ref": "#/components/schemas/PaginatedResultHref" }, "next": { "$ref": "#/components/schemas/PaginatedResultHref" } } }, "_embedded": { "type": "object", "items": {} } } }, "CountryCode": { "type": "string", "description": "ISO 3166 Country short name.", "minLength": 2, "maxLength": 2, "example": "ES" }, "BusinessProfileStatusValues": { "type": "string", "description": "Overall registration status of a Business Profile.", "enum": [ "pending", "reviewed", "ready-to-provision", "provisioning", "accepted", "partially-accepted", "rejected", "failed" ], "example": "reviewed" }, "BusinessProfileStatus": { "type": "object", "readOnly": true, "required": [ "status" ], "properties": { "status": { "$ref": "#/components/schemas/BusinessProfileStatusValues" }, "message": { "type": "string", "maxLength": 100, "description": "Brief description of why the Business Profile was rejected." } } }, "BusinessInformation": { "type": "object", "required": [ "address_street_1", "postal_code", "country", "city" ], "properties": { "address_street_1": { "type": "string", "maxLength": 500, "description": "Address of the company.", "example": "Main Street 5" }, "address_street_2": { "type": "string", "maxLength": 500, "description": "Additional space to enter the address of the company.", "example": "Extra long address" }, "postal_code": { "type": "string", "maxLength": 500, "description": "Zip/Postal Code of the company location.", "example": "W1 5DU" }, "country": { "$ref": "#/components/schemas/CountryCode" }, "city": { "type": "string", "maxLength": 500, "description": "City where the company is located.", "example": "London" }, "province": { "type": "string", "maxLength": 500, "description": "State/Province where the company is located.", "example": "City of London" } } }, "BusinessProfileChangeRequestStatusValues": { "type": "string", "description": "Status of change request for business profile", "enum": [ "rejected", "pending", "accepted" ], "example": "pending" }, "BusinessProfileChangeRequestStatus": { "type": "object", "readOnly": true, "required": [ "status" ], "properties": { "status": { "$ref": "#/components/schemas/BusinessProfileChangeRequestStatusValues" }, "message": { "type": "string", "maxLength": 100, "description": "Brief description of why the change request was rejected/accepted." } } }, "BusinessProfileChangeRequest": { "type": "object", "description": "The payload for making a change on an existing network Business Profile.", "properties": { "countries": { "type": "array", "items": { "$ref": "#/components/schemas/CountryCode" } }, "contact_role": { "type": "string", "maxLength": 100, "description": "Role of the person creating the business profile.", "example": "A Business Profile" }, "name": { "type": "string", "maxLength": 100, "description": "Alias for the Network Business Profile.", "example": "A Business Profile" }, "trading_name": { "type": "string", "maxLength": 100, "description": "Network Business Profile trading name.", "example": "A Business Profile Ltd." }, "organisation_type": { "type": "string", "maxLength": 100, "description": "Organisation type of the business.", "example": "For-Profit Organisation" }, "tax_number": { "type": "string", "maxLength": 100, "description": "Business registration tax number.", "example": "98284687G" }, "business_registration_id": { "type": "string", "maxLength": 100, "description": "Business registration ID.", "example": "15-048-3782" }, "issuing_authority": { "type": "string", "maxLength": 100, "description": "Business registration ID issuing authority.", "example": "National Government" }, "privacy_policy_url": { "type": "string", "format": "uri", "maxLength": 500, "description": "Link to the business privacy policy.", "example": "https://www.businessinc.com/privacy_policy" }, "privacy_policy_manager_email": { "type": "string", "format": "email", "description": "Privacy policy manager contact email address.", "example": "privacy.manager@business.com" }, "dpo_email": { "type": "string", "format": "email", "description": "Data protection officer contact email address.", "example": "dpo@business.com" }, "dpo_required": { "type": "boolean", "description": "Flag to check if a data protection officer is required by law." }, "terms_and_conditions_accepted": { "type": "boolean", "description": "Set to true to accept terms and conditions. You may retrieve the latest version of those terms and conditions using the catalogue T&C endpoint." }, "business_information": { "$ref": "#/components/schemas/BusinessInformation" }, "email_notifications_enabled": { "type": "boolean", "description": "Flag to agree to email notifications for status updated." }, "status": { "$ref": "#/components/schemas/BusinessProfileChangeRequestStatus" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the Business Profile was created.", "example": "2023-11-07T07:20:50.52Z", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "Date when the Business Profile was updated for the last time.", "example": "2023-11-08T10:12:20.52Z", "readOnly": true }, "vetting_terms_and_conditions_accepted": { "type": "boolean", "description": "Set to true to accept vetting terms and conditions. You may retrieve the latest version of those vetting terms and conditions using the catalogue T&C endpoint." }, "vetting_extra_fields": { "type": "object", "description": "Map with all the vetting fields and values required by the vetting levels that apply to the Business Profile.", "additionalProperties": { "type": "string" }, "example": { "tax_number_type": "NIF", "duns_number": "123456789" } } } }, "BusinessProfileNotification": { "description": "Custom Notification for a Business Profile.", "type": "object", "required": [ "created_at", "message", "dismissed" ], "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date when the Notification was created.", "example": "2023-11-07T07:20:50.52Z", "readOnly": true }, "message": { "type": "string", "maxLength": 1000, "description": "Notification message.", "example": "This profile requires your attention. Please modify it." }, "dismissed": { "type": "boolean", "description": "Flag to indicate if this Notification has been dismissed by the User.", "readOnly": true }, "require_changes": { "type": "boolean", "description": "Flag to indicate if this Notification will require changes performed by the User." } } }, "VettingInfo": { "type": "object", "description": "Information regarding vetting process.", "required": [ "consent" ], "properties": { "consent": { "type": "string", "description": "Acknowledgement to proceed with the vetting process.", "enum": [ "not_required", "consented", "not_consented" ], "example": "consented" }, "vetting_levels": { "type": "array", "nullable": true, "description": "List of vetting levels applied to the business profile at the time it was created.", "example": [ "standard", "escalated_plus" ], "items": { "type": "string", "example": "escalated_plus" } } } }, "VettingResult": { "type": "object", "description": "Information regarding the outcome of the vetting process.", "properties": { "result": { "type": "string", "nullable": true, "description": "Outcome of the vetting process.", "enum": [ "successful", "unsuccessful" ], "example": "successful" }, "message": { "type": "string", "nullable": true, "description": "Human readable explanation of the vetting process result.", "example": "Vetting finished successfully." } } }, "BusinessProfile": { "description": "The payload for creation of a network Business Profile.", "type": "object", "required": [ "id", "account_id", "countries", "contact_role", "name", "organisation_type", "tax_number", "privacy_policy_url", "privacy_policy_manager_email", "terms_and_conditions_accepted", "status", "created_at", "updated_at", "business_information", "nr_notifications" ], "properties": { "id": { "type": "string", "description": "Internal id of the Business Profile.", "example": "2hothFWw2ssb3y3lhh5Fu3tzfqV", "readOnly": true }, "account_id": { "type": "string", "description": "Internal id of account that owns the Business Profile.", "example": "acc102846", "readOnly": true }, "countries": { "type": "array", "description": "List of ISO 3166 country short names where this business profile will operate. A more complete and up to date list of supported countries can be obtained in `/v1/network-registry/catalogue/countries`.", "example": [ "ES", "DE" ], "items": { "$ref": "#/components/schemas/CountryCode" } }, "contact_role": { "type": "string", "maxLength": 100, "description": "Role of the person creating the business profile.", "example": "A Business Profile" }, "name": { "type": "string", "maxLength": 100, "description": "Alias for the Network Business Profile.", "example": "A Business Profile" }, "trading_name": { "type": "string", "maxLength": 100, "description": "Network Business Profile trading name.", "example": "A Business Profile Ltd." }, "organisation_type": { "type": "string", "maxLength": 100, "description": "Organisation type of the business. A more complete and up-to-date list of supported organisation types can be obtained in `/v1/network-registry/catalogue/organisation-types`.", "enum": [ "academicScientificOrganisation", "forProfitOrganisation", "governmentalOrganisation", "industryConsortium", "internationalOrganisation", "nonProfitOrganisation", "nonGovernmentalOrganisation", "organisationalUnit" ], "example": "forProfitOrganisation" }, "tax_number": { "type": "string", "maxLength": 100, "description": "Business registration tax number.", "example": "98284687G" }, "business_registration_id": { "type": "string", "maxLength": 100, "description": "Business registration ID.", "example": "15-048-3782" }, "issuing_authority": { "type": "string", "maxLength": 100, "description": "Business registration ID issuing authority.", "example": "National Government" }, "privacy_policy_url": { "type": "string", "format": "uri", "maxLength": 500, "description": "Link to the business privacy policy.", "example": "https://www.businessinc.com/privacy_policy" }, "privacy_policy_manager_email": { "type": "string", "format": "email", "description": "Privacy policy manager contact email address.", "example": "privacy.manager@business.com" }, "dpo_email": { "type": "string", "format": "email", "description": "Data protection officer contact email address.", "example": "dpo@business.com" }, "dpo_required": { "type": "boolean", "description": "Flag to check if a data protection officer is required by law." }, "terms_and_conditions_accepted": { "type": "boolean", "description": "Set to true to accept terms and conditions. You may retrieve the latest version of those terms and conditions using the catalogue T&C endpoint." }, "status": { "$ref": "#/components/schemas/BusinessProfileStatus" }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the Business Profile was created.", "example": "2023-11-07T07:20:50.52Z", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "Date when the Business Profile was updated for the last time.", "example": "2023-11-08T10:12:20.52Z", "readOnly": true }, "delete_at": { "type": "string", "format": "date-time", "description": "Date when the Network Application Profile request will be deleted.", "example": "2023-11-08T10:12:20.52Z", "nullable": true, "readOnly": true }, "business_information": { "$ref": "#/components/schemas/BusinessInformation" }, "email_notifications_enabled": { "type": "boolean", "description": "Flag to agree to email notifications for status updated." }, "change_request": { "allOf": [ { "$ref": "#/components/schemas/BusinessProfileChangeRequest" } ], "readOnly": true, "example": null }, "notification": { "allOf": [ { "$ref": "#/components/schemas/BusinessProfileNotification" } ], "readOnly": true }, "nr_notifications": { "type": "integer", "description": "The number of non-dismissed notifications including this Business Profile and all its Application Profiles.", "minimum": 0, "readOnly": true, "example": 1 }, "vetting_terms_and_conditions_accepted": { "type": "boolean", "description": "Set to true to accept vetting terms and conditions. You may retrieve the latest version of those vetting terms and conditions using the catalogue T&C endpoint." }, "vetting_extra_fields": { "type": "object", "nullable": true, "description": "Map with all the vetting fields and values required by the vetting levels that apply to the Business Profile. The required vetting levels will be computed depending on the CSPs operating in the countries selected for this Business Profile. Once the vetting levels are calculated, the mandatory extra fields for each level will be the ones returned by the catalogue get a vetting level endpoint.", "additionalProperties": { "type": "string" }, "example": { "tax_number_type": "NIF", "duns_number": "123456789" } }, "vetting_info": { "allOf": [ { "$ref": "#/components/schemas/VettingInfo" } ], "readOnly": true }, "vetting_result": { "nullable": true, "allOf": [ { "$ref": "#/components/schemas/VettingResult" } ], "readOnly": true } } }, "ErrorResponse": { "type": "object", "required": [ "title", "type", "instance" ], "properties": { "title": { "type": "string", "description": "Error title.", "example": "Bad Request" }, "type": { "type": "string", "description": "Link to documented error type.", "example": "https://developer.vonage.com/api-errors#bad-request" }, "detail": { "type": "string", "description": "More detailed error descriptions.", "example": "Incorrect code" }, "instance": { "type": "string", "description": "UUID reference for the instance.", "example": "06032957-99ce-41ee-978b-9a390cd5a89b" } } }, "InvalidParametersResponse": { "required": [ "invalid_parameters" ], "allOf": [ { "$ref": "#/components/schemas/ErrorResponse" }, { "type": "object", "properties": { "invalid_parameters": { "type": "array", "description": "Detailed array of errors.", "items": { "type": "object", "properties": { "name": { "type": "string" }, "reason": { "type": "string" } } }, "example": { "name": "countries", "reason": "Invalid country code" } } } } ] }, "BusinessProfileCspStatusValues": { "description": "Registration status of a Business Profile within a CSP.", "type": "string", "enum": [ "not-submitted", "waiting-for-vetting", "ready-to-provision", "ready-to-update", "provisioning", "accepted", "rejected", "failed" ], "example": "not-submitted" }, "BusinessProfileCspStatus": { "description": "Business Profile registration status in the CSP.", "type": "object", "required": [ "account_id", "business_profile_id", "csp_id", "status", "created_at", "updated_at" ], "properties": { "csp_id": { "type": "string", "description": "Id of the CSP", "example": "telefonica_es", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the CSP was notified.", "example": "2023-11-07T07:20:50.52Z", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "Date when the CSP updated the status.", "example": "2023-11-08T10:12:20.52Z", "readOnly": true }, "status": { "$ref": "#/components/schemas/BusinessProfileCspStatusValues" }, "message": { "type": "string", "maxLength": 1000, "description": "Brief description of why the Business Profile was rejected by the CSP.", "example": "Some message" }, "business_profile_id": { "type": "string", "description": "Id of the Business Profile.", "example": "2hothFWw2ssb3y3lhh5Fu3tzfqV", "readOnly": true }, "account_id": { "type": "string", "description": "Id of the Vonage Account.", "example": "acc102846", "readOnly": true } } }, "Share": { "type": "object", "required": [ "account_id" ], "properties": { "account_id": { "type": "string", "description": "Id of the Vonage Account.", "example": "acc102846", "readOnly": true } } }, "ApplicationProfileStatusValues": { "type": "string", "description": "Overall network Application Profile status.", "enum": [ "pending", "provisioning", "accepted", "partially-accepted", "rejected", "failed" ] }, "CategoryValues": { "type": "string", "description": "A category of the network Application Profile. A more complete and up-to-date list of supported categories can be obtained in `/v1/network-registry/catalogue/categories`.", "maxLength": 100, "enum": [ "artAndDesign", "autoAndVehicle", "beauty", "booksAndReference", "business", "developerTools", "education", "eventsAndEntertainment", "finance", "foodAndDrink", "games", "healthAndFitness", "kids", "librariesAndDemo", "lifestyle", "mapsAndNavigation", "medical", "musicAndAudio", "newsAndMagazines", "photoAndVideo", "productivity", "shopping", "socialNetworkingAndCommunications", "sports", "utilities", "travelAndLocal", "weather" ], "example": "finance" }, "ApplicationProfileStatus": { "type": "object", "readOnly": true, "required": [ "status" ], "properties": { "status": { "$ref": "#/components/schemas/ApplicationProfileStatusValues" }, "message": { "type": "string", "maxLength": 100, "description": "Brief description of why the application profile was rejected." } } }, "NetworkApiTypes": { "type": "object", "required": [ "network_api_id", "purpose_ids" ], "properties": { "network_api_id": { "type": "string", "description": "Id of the Network API. A more complete and\nup-to-date list of supported categories can be obtained in\n`/v1/network-registry/catalogue/network-apis`.\n\nSample values:\n\n- sim-swap\n- number-verification\n- device-status\n- qod\n- verify-silent-authentication\n", "example": "sim-swap" }, "purpose_ids": { "type": "array", "description": "List of purposes is required by the network operator to validate the request. A more complete and up-to-date list of supported purposes can be obtained in `/v1/network-registry/catalogue/purposes`.", "example": [ "FraudPreventionAndDetection" ], "items": { "type": "string", "example": "FraudPreventionAndDetection" } } } }, "ApplicationProfileNotification": { "description": "Custom Notification for an Application Profile.", "type": "object", "required": [ "created_at", "message", "dismissed" ], "properties": { "created_at": { "type": "string", "format": "date-time", "description": "Date when the Notification was created.", "example": "2023-11-07T07:20:50.52Z", "readOnly": true }, "message": { "type": "string", "maxLength": 1000, "description": "Notification message.", "example": "This profile requires your attention. Please modify it." }, "dismissed": { "type": "boolean", "description": "Flag to indicate if this Notification has been dismissed by the User.", "readOnly": true } } }, "ApplicationProfile": { "description": "The response payload of a network Application Profile.", "type": "object", "required": [ "id", "business_profile_id", "account_id", "name", "category_id", "status", "created_at", "updated_at", "network_apis", "infrastructure_locations" ], "properties": { "id": { "type": "string", "description": "Internal id of a network Application Profile.", "example": "2hotg2Wzoy65nG6VKNaap4VFQvC", "readOnly": true }, "business_profile_id": { "type": "string", "maxLength": 100, "description": "Id of the Business Profile that owns the Application Profile.", "example": "2hothFWw2ssb3y3lhh5Fu3tzfqV" }, "account_id": { "type": "string", "maxLength": 50, "description": "Id of the Vonage account, known as apiKey, that owns the network Application Profile.", "example": "acc102846", "readOnly": true }, "name": { "type": "string", "maxLength": 100, "description": "An Application Profile name", "example": "Network Application Profile" }, "description": { "type": "string", "maxLength": 1000, "description": "The Application use cases description.", "example": "This Network Application Profile main use case is for Fraud Prevention" }, "category_id": { "$ref": "#/components/schemas/CategoryValues" }, "status": { "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/ApplicationProfileStatus" } ] }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the Network Application Profile request was created.", "example": "2023-11-07T07:20:50.52Z", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "Date when the Network Application Profile request was updated.", "example": "2023-11-08T10:12:20.52Z", "readOnly": true }, "delete_at": { "type": "string", "format": "date-time", "description": "Date when the Network Application Profile request will be deleted.", "example": "2023-11-08T10:12:20.52Z", "nullable": true, "readOnly": true }, "network_apis": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkApiTypes" } }, "terms_and_conditions_accepted": { "type": "boolean", "description": "Set to true to accept terms and conditions. You may retrieve the latest version of those terms and conditions using the catalogue T&C endpoint." }, "infrastructure_locations": { "type": "array", "items": { "$ref": "#/components/schemas/CountryCode" } }, "notification": { "allOf": [ { "$ref": "#/components/schemas/ApplicationProfileNotification" } ], "readOnly": true }, "privacy_policy_url": { "type": "string", "format": "uri", "maxLength": 500, "description": "Link to the application profile privacy policy.", "example": "https://www.businessinc.com/application_privacy_policy" } } }, "ApplicationProfileCspStatusValues": { "type": "string", "description": "Registration status of a Application Profile within a CSP.", "enum": [ "not-submitted", "ready-for-provisioning", "ready-to-update", "provisioning-application", "application-accepted", "provisioning-order", "accepted", "rejected", "failed" ], "example": "not-submitted" }, "ConnectivityStatus": { "type": "string", "description": "Connectivity status", "enum": [ "UNKNOWN", "OK", "ERROR" ] }, "ApplicationProfileCspStatus": { "type": "object", "description": "Application Profile registration status in the CSP.", "required": [ "csp_id", "status", "created_at", "updated_at", "business_profile_id", "application_profile_id", "account_id" ], "properties": { "csp_id": { "type": "string", "description": "Id of the CSP.", "example": "telefonica_es", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "Date when the CSP was notified.", "example": "2023-11-07T07:20:50.52Z", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "Date when the CSP updated the status.", "example": "2023-11-08T10:12:20.52Z", "readOnly": true }, "delete_at": { "type": "string", "format": "date-time", "description": "Date when the Network Application Profile request will be deleted.", "example": "2023-11-08T10:12:20.52Z", "nullable": true, "readOnly": true }, "status": { "$ref": "#/components/schemas/ApplicationProfileCspStatusValues" }, "previous_status": { "$ref": "#/components/schemas/ApplicationProfileCspStatusValues" }, "message": { "type": "string", "description": "Brief description of why the Application Profile was rejected by the CSP.", "example": "Some message" }, "application_profile_id": { "type": "string", "description": "Id of the Application Profile.", "example": "2hotg2Wzoy65nG6VKNaap4VFQvC", "readOnly": true }, "business_profile_id": { "type": "string", "description": "Id of the Business Profile.", "example": "2hothFWw2ssb3y3lhh5Fu3tzfqV", "readOnly": true }, "account_id": { "type": "string", "description": "Id of the Vonage Account.", "example": "acc102846", "readOnly": true }, "allowlist_check_required": { "type": "boolean", "description": "If this CSP requires verifying if the number is whitelisted in GNP Allowlist.\n", "example": false }, "network_apis": { "type": "array", "description": "List of the ids of the Network APIs used by this Application Profile.\n", "example": [ "sim-swap", "number-verification" ], "items": { "type": "string" } }, "connectivity_status": { "$ref": "#/components/schemas/ConnectivityStatus" } } }, "LinkedApplication": { "type": "object", "required": [ "account_id", "vonage_application_id" ], "properties": { "account_id": { "type": "string", "description": "Id of the Vonage Account.", "example": "acc102846" }, "vonage_application_id": { "type": "string", "description": "Vonage Application ID", "example": "d65hx4ghh" } } }, "Country": { "type": "object", "required": [ "code", "name" ], "properties": { "code": { "$ref": "#/components/schemas/CountryCode" }, "name": { "type": "string", "description": "The country display name (in English).", "example": "Spain" } } }, "OrganisationType": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "Id of the Organisation Type.", "example": "forProfitOrganisation" }, "name": { "type": "string", "description": "The Organisation Type display name (in English).", "example": "For-Profit Organisation" } } }, "Category": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "Id of the Category.", "example": "autoAndVehicle" }, "name": { "type": "string", "description": "The Category display name (in English).", "example": "Auto and Vehicle" } } }, "Csp": { "description": "Communication Service Provider.", "type": "object", "required": [ "id", "name", "country" ], "properties": { "id": { "type": "string", "example": "telefonica_es" }, "name": { "type": "string", "description": "CSP Name.", "maxLength": 255, "example": "Telefonica" }, "country": { "$ref": "#/components/schemas/CountryCode" }, "supported_network_apis": { "type": "array", "description": "Ids of the Network APIs supported by the CSP.", "example": [ "sim-swap", "number-verification" ], "items": { "type": "string" } }, "vetting_level": { "type": "string", "description": "Vetting level for this CSP.\n", "example": "standard_vetting" } } }, "NetworkAPI": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "description": "Id of the Network API.", "example": "sim-swap" }, "name": { "type": "string", "description": "The Network API display name (in English).", "example": "SIM Swap" }, "requires": { "type": "array", "description": "List of requirements of the Network API", "items": { "type": "string", "enum": [ "nv_redirect_url", "qod_callback_url", "verify_callback_url" ], "example": [ "nv_redirect_url" ] } } } }, "Purpose": { "type": "object", "required": [ "id", "name", "network_api_id" ], "properties": { "id": { "type": "string", "description": "Id of the Purpose.", "example": "fraudPreventionAndDetection" }, "name": { "type": "string", "description": "The Purpose display name (in English)", "example": "Fraud Prevention and Detection" }, "network_api_id": { "type": "string", "description": "Id of the Network API that the Purpose belongs to.", "example": "sim-swap" } } }, "VettingLevel": { "type": "object", "required": [ "id", "name", "description", "extra_fields" ], "properties": { "id": { "type": "string", "description": "Id of the vetting level.", "example": "standard_level" }, "name": { "type": "string", "description": "The vetting level display name (in English)", "example": "Standard level" }, "description": { "type": "string", "description": "Description of the vetting level.", "example": "Standard vetting level" }, "extra_fields": { "type": "array", "description": "List of extra fields required by the vetting level", "items": { "type": "string" }, "example": [ "legal_company_name", "business_registration_registrar" ] } } }, "TermsAndConditions": { "type": "object", "required": [ "id", "name", "text" ], "properties": { "id": { "type": "string", "description": "Id of the Terms and Conditions.", "example": "general" }, "name": { "type": "string", "description": "The Terms and Conditions display name (in English).", "example": "General terms and conditions" }, "text": { "type": "string", "description": "Description of the Terms and Conditions.", "example": "T&Cs are determined by Network Registry. You may retrieve the latest version of those terms and \nconditions using the Network Registry T&C endpoint.\n" } } } }, "examples": { "InvalidParametersExample": { "value": { "title": "Bad Request", "type": "https://developer.vonage.com/api-errors#invalid-param", "detail": "The value of one or more parameters is invalid", "instance": "06032957-99ce-41ee-978b-9a390cd5a89", "invalidParams": [ { "name": "countries", "reason": "Invalid country code" } ] } }, "InternalErrorExample": { "value": { "title": "Internal Error", "type": "https://developer.vonage.com/api-errors#internal-error", "detail": "An unknown error has occurred", "instance": "06032957-99ce-41ee-978b-9a390cd5a89" } }, "MaxNumberOfCreatedProfilesReachedExample": { "value": { "title": "Conflict", "type": "https://developer.vonage.com/api-errors#conflict", "detail": "Maximum number of created profiles reached [50]", "instance": "06032957-99ce-41ee-978b-9a390cd5a89" } }, "InvalidEntityExample": { "value": { "title": "Conflict", "type": "https://developer.vonage.com/api-errors#conflict", "detail": "DPO email is mandatory if DPO required field is checked.", "instance": "06032957-99ce-41ee-978b-9a390cd5a89" } }, "UnsupportedCountryExample": { "value": { "title": "Conflict", "type": "https://developer.vonage.com/api-errors#conflict", "detail": "Country CountryCode(code=HK) is not supported. Supported countries are [CountryCode(code=ES)]", "instance": "06032957-99ce-41ee-978b-9a390cd5a89" } }, "BadRequestExample": { "value": { "title": "Bad Request", "type": "https://developer.vonage.com/api-errors#bad-request", "detail": "Invalid parameter", "invalid_parameters": [], "instance": "06032957-99ce-41ee-978b-9a390cd5a89" } }, "NotFoundExample": { "value": { "title": "Not Found", "type": "https://developer.vonage.com/api-errors#not-found", "detail": "Entity with id XYZ not found", "instance": "06032957-99ce-41ee-978b-9a390cd5a89" } }, "CanNotDeleteEntityExample": { "value": { "title": "Conflict", "type": "https://developer.vonage.com/api-errors#conflict", "detail": "Cannot delete entity", "instance": "06032957-99ce-41ee-978b-9a390cd5a89" } }, "CanNotUndeleteEntityExample": { "value": { "title": "Conflict", "type": "https://developer.vonage.com/api-errors#conflict", "detail": "Cannot undelete entity", "instance": "06032957-99ce-41ee-978b-9a390cd5a89" } }, "BusinessProfileNotFoundExample": { "value": { "title": "Conflict", "type": "https://developer.vonage.com/api-errors#conflict", "detail": "No business profile found with id 2hothFWw2ssb3y3lhh5Fu3tzfqV", "instance": "06032957-99ce-41ee-978b-9a390cd5a89" } }, "UnsupportedNetworkApiExample": { "value": { "title": "Conflict", "type": "https://developer.vonage.com/api-errors#conflict", "detail": "Network API swap-sim is not supported. Supported network APIs are [sim-swap]", "instance": "06032957-99ce-41ee-978b-9a390cd5a89" } }, "CanNotDeleteDueToLinkedApplication": { "value": { "title": "ProfileInUse", "type": "https://developer.vonage.com/api-errors#conflict", "detail": "Cannot delete, there are linked Vonage applications, please unlink before deleting.", "instance": "06032957-99ce-41ee-978b-9a390cd5a89" } }, "CanNotDeleteDueToSharedLinkedApplication": { "value": { "title": "SharedProfileInUse", "type": "https://developer.vonage.com/api-errors#conflict", "detail": "Cannot delete, one or more of the shared accounts have linked this application to a Vonage application.", "instance": "06032957-99ce-41ee-978b-9a390cd5a89" } }, "SandboxTestApplicationNotFoundExample": { "value": { "title": "Not Found", "type": "https://developer.vonage.com/api-errors#not-found", "detail": "Sandbox test application is not configured for CSP telefonica_es", "instance": "06032957-99ce-41ee-978b-9a390cd5a89" } }, "ShareExample": { "value": { "account_id": "acc102846" } }, "MaxNumberOfSharedProfilesReachedExample": { "value": { "title": "Conflict", "type": "https://developer.vonage.com/api-errors#conflict", "detail": "Maximum number of shared profiles reached [50]", "instance": "06032957-99ce-41ee-978b-9a390cd5a89" } }, "CanNotShareEntityExample": { "value": { "title": "Conflict", "type": "https://developer.vonage.com/api-errors#conflict", "detail": "Cannot share entity", "instance": "06032957-99ce-41ee-978b-9a390cd5a89" } }, "CanNotUnshareEntityExample": { "value": { "title": "Conflict", "type": "https://developer.vonage.com/api-errors#conflict", "detail": "Cannot unshare entity", "instance": "06032957-99ce-41ee-978b-9a390cd5a89" } }, "CanNotUnshareDueToEntityExample": { "value": { "title": "SharedProfileInUse", "type": "https://developer.vonage.com/api-errors#conflict", "detail": "Cannot unshare, one or more of the shared accounts have linked this application to a vonage applications.", "instance": "06032957-99ce-41ee-978b-9a390cd5a89" } }, "BusinessProfileChangeRequestExample": { "value": { "id": "06032957-99ce-41ee-978b-9a390cd5a89", "account_id": "acc102846", "countries": [ "ES", "DE" ], "contact_role": "A Business Profile", "name": "A Business Profile", "trading_name": "A Business Profile Ltd.", "organisation_type": "forProfitOrganisation", "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, "status": { "status": "reviewed", "message": "Some message" }, "created_at": "2023-11-07T07:20:50.52Z", "updated_at": "2023-11-08T10:12:20.52Z", "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, "email_hostname": "business.com", "change_request": { "contact_role": "A Contact Role" } } } } } }