Network Registry

The Vonage Network Registry handles pre-registration and approval with multiple Mobile Operators (also knows as Communication Service Providers or CSPs), which is required before using Network APIs. Note that Operator responses to registration requests are asynchronous and may be received by the Vonage Network Registry at different times.

Descargar la especificación OpenAPI

Business Profile

Business Profiles are used to define the organization, or legal entity, requesting access to Network APIs and will be shared with CSPs in the countries included with the business profile.

Operaciones disponibles

Create a new network Business Profile registration.

Create a new network Business Profile registration. There is a limit of 50 business profiles per account.

posthttps://api-eu.vonage.com/v1/network-registry/business-profiles

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Cuerpo de la solicitud
Tipo de contenido
application/json

countries

array

Requerido

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.

contact_role

string

Requerido

Max100

ejemploA Business Profile

Role of the person creating the business profile.

name

string

Requerido

Max100

ejemploA Business Profile

Alias for the Network Business Profile.

trading_name

string

Max100

ejemploA Business Profile Ltd.

Network Business Profile trading name.

organisation_type

string

Requerido

Max100

ejemploforProfitOrganisation

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.

Debe ser uno de:academicScientificOrganisationforProfitOrganisationgovernmentalOrganisationindustryConsortiuminternationalOrganisationnonProfitOrganisationnonGovernmentalOrganisationorganisationalUnit

tax_number

string

Requerido

Max100

ejemplo98284687G

Business registration tax number.

business_registration_id

string

Max100

ejemplo15-048-3782

Business registration ID.

issuing_authority

string

Max100

ejemploNational Government

Business registration ID issuing authority.

privacy_policy_url

string(uri)

Requerido

Max500

ejemplohttps://www.businessinc.com/privacy_policy

Link to the business privacy policy.

privacy_policy_manager_email

string(email)

Requerido

ejemploprivacy.manager@business.com

dpo_email

string(email)

ejemplodpo@business.com

Data protection officer contact email address.

dpo_required

boolean

Flag to check if a data protection officer is required by law.

terms_and_conditions_accepted

boolean

Requerido

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

object

Requerido

address_street_1

string

Requerido

Max500

ejemploMain Street 5

Address of the company.

address_street_2

string

Max500

ejemploExtra long address

Additional space to enter the address of the company.

postal_code

string

Requerido

Max500

ejemploW1 5DU

Zip/Postal Code of the company location.

country

string

Requerido

Min2

Max2

ejemploES

ISO 3166 Country short name.

city

string

Requerido

Max500

ejemploLondon

City where the company is located.

province

string

Max500

ejemploCity of London

State/Province where the company is located.

email_notifications_enabled

boolean

Flag to agree to email notifications for status updated.

vetting_terms_and_conditions_accepted

boolean

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

object

ejemplo

{
  "tax_number_type": "NIF",
  "duns_number": "123456789"
}

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.

Ejemplo Solicitar

{
   "countries": [
      "ES",
      "DE"
   ],
   "contact_role": "A Business Profile",
   "name": "A Business Profile",
   "trading_name": "A Business Profile Ltd.",
   "organisation_type": "forProfitOrganisation",
   "tax_number": "98284687G",
   "business_registration_id": "15-048-3782",
   "issuing_authority": "National Government",
   "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": "ES",
      "city": "London",
      "province": "City of London"
   },
   "email_notifications_enabled": true,
   "vetting_terms_and_conditions_accepted": true,
   "vetting_extra_fields": {
      "tax_number_type": "NIF",
      "duns_number": "123456789"
   }
}

{
   "countries": [
      "ES",
      "DE"
   ],
   "contact_role": "A Business Profile",
   "name": "A Business Profile",
   "trading_name": "A Business Profile Ltd.",
   "organisation_type": "forProfitOrganisation",
   "tax_number": "98284687G",
   "business_registration_id": "15-048-3782",
   "issuing_authority": "National Government",
   "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": "ES",
      "city": "London",
      "province": "City of London"
   },
   "email_notifications_enabled": true,
   "vetting_terms_and_conditions_accepted": true,
   "vetting_extra_fields": {
      "tax_number_type": "NIF",
      "duns_number": "123456789"
   }
}

Respuestas
Tipo de contenido
application/json

The created network Business Profile registration.

string

Requerido

ejemplo2hothFWw2ssb3y3lhh5Fu3tzfqV

Internal id of the Business Profile.

account_id

string

Requerido

ejemploacc102846

Internal id of account that owns the Business Profile.

countries

array

Requerido

contact_role

string

Requerido

Max100

ejemploA Business Profile

Role of the person creating the business profile.

name

string

Requerido

Max100

ejemploA Business Profile

Alias for the Network Business Profile.

trading_name

string

Max100

ejemploA Business Profile Ltd.

Network Business Profile trading name.

organisation_type

string

Requerido

Max100

ejemploforProfitOrganisation

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.

tax_number

string

Requerido

Max100

ejemplo98284687G

Business registration tax number.

business_registration_id

string

Max100

ejemplo15-048-3782

Business registration ID.

issuing_authority

string

Max100

ejemploNational Government

Business registration ID issuing authority.

privacy_policy_url

string(uri)

Requerido

Max500

ejemplohttps://www.businessinc.com/privacy_policy

Link to the business privacy policy.

privacy_policy_manager_email

string(email)

Requerido

ejemploprivacy.manager@business.com

dpo_email

string(email)

ejemplodpo@business.com

Data protection officer contact email address.

dpo_required

boolean

Flag to check if a data protection officer is required by law.

terms_and_conditions_accepted

boolean

Requerido

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

object

Requerido

status

string

Requerido

ejemploreviewed

Overall registration status of a Business Profile.

Debe ser uno de:pendingreviewedready-to-provisionprovisioningacceptedpartially-acceptedrejectedfailed

message

string

Max100

Brief description of why the Business Profile was rejected.

created_at

string(date-time)

Requerido

ejemplo2023-11-07T07:20:50.52Z

Date when the Business Profile was created.

updated_at

string(date-time)

Requerido

ejemplo2023-11-08T10:12:20.52Z

Date when the Business Profile was updated for the last time.

delete_at

string(date-time)

ejemplo2023-11-08T10:12:20.52Z

Date when the Network Application Profile request will be deleted.

business_information

object

Requerido

address_street_1

string

Requerido

Max500

ejemploMain Street 5

Address of the company.

address_street_2

string

Max500

ejemploExtra long address

Additional space to enter the address of the company.

postal_code

string

Requerido

Max500

ejemploW1 5DU

Zip/Postal Code of the company location.

country

string

Requerido

Min2

Max2

ejemploES

ISO 3166 Country short name.

city

string

Requerido

Max500

ejemploLondon

City where the company is located.

province

string

Max500

ejemploCity of London

State/Province where the company is located.

email_notifications_enabled

boolean

Flag to agree to email notifications for status updated.

change_request

object

The payload for making a change on an existing network Business Profile.

countries

array

contact_role

string

Max100

ejemploA Business Profile

Role of the person creating the business profile.

name

string

Max100

ejemploA Business Profile

Alias for the Network Business Profile.

trading_name

string

Max100

ejemploA Business Profile Ltd.

Network Business Profile trading name.

organisation_type

string

Max100

ejemploFor-Profit Organisation

Organisation type of the business.

tax_number

string

Max100

ejemplo98284687G

Business registration tax number.

business_registration_id

string

Max100

ejemplo15-048-3782

Business registration ID.

issuing_authority

string

Max100

ejemploNational Government

Business registration ID issuing authority.

privacy_policy_url

string(uri)

Max500

ejemplohttps://www.businessinc.com/privacy_policy

Link to the business privacy policy.

privacy_policy_manager_email

string(email)

ejemploprivacy.manager@business.com

dpo_email

string(email)

ejemplodpo@business.com

Data protection officer contact email address.

dpo_required

boolean

Flag to check if a data protection officer is required by law.

terms_and_conditions_accepted

boolean

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

object

address_street_1

string

Requerido

Max500

ejemploMain Street 5

Address of the company.

address_street_2

string

Max500

ejemploExtra long address

Additional space to enter the address of the company.

postal_code

string

Requerido

Max500

ejemploW1 5DU

Zip/Postal Code of the company location.

country

string

Requerido

Min2

Max2

ejemploES

ISO 3166 Country short name.

city

string

Requerido

Max500

ejemploLondon

City where the company is located.

province

string

Max500

ejemploCity of London

State/Province where the company is located.

email_notifications_enabled

boolean

Flag to agree to email notifications for status updated.

status

object

status

string

Requerido

ejemplopending

Status of change request for business profile

Debe ser uno de:rejectedpendingaccepted

message

string

Max100

Brief description of why the change request was rejected/accepted.

created_at

string(date-time)

ejemplo2023-11-07T07:20:50.52Z

Date when the Business Profile was created.

updated_at

string(date-time)

ejemplo2023-11-08T10:12:20.52Z

Date when the Business Profile was updated for the last time.

vetting_terms_and_conditions_accepted

boolean

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

object

ejemplo

{
  "tax_number_type": "NIF",
  "duns_number": "123456789"
}

Map with all the vetting fields and values required by the vetting levels that apply to the Business Profile.

notification

object

Custom Notification for a Business Profile.

created_at

string(date-time)

Requerido

ejemplo2023-11-07T07:20:50.52Z

Date when the Notification was created.

message

string

Requerido

Max1000

ejemploThis profile requires your attention. Please modify it.

Notification message.

dismissed

boolean

Requerido

Flag to indicate if this Notification has been dismissed by the User.

require_changes

boolean

Flag to indicate if this Notification will require changes performed by the User.

nr_notifications

integer

Requerido

ejemplo1

The number of non-dismissed notifications including this Business Profile and all its Application Profiles.

vetting_terms_and_conditions_accepted

boolean

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

object

ejemplo

{
  "tax_number_type": "NIF",
  "duns_number": "123456789"
}

vetting_info

object

Information regarding vetting process.

consent

string

Requerido

ejemploconsented

Acknowledgement to proceed with the vetting process.

Debe ser uno de:not_requiredconsentednot_consented

vetting_levels

array

List of vetting levels applied to the business profile at the time it was created.

vetting_result

object

Information regarding the outcome of the vetting process.

result

string

ejemplosuccessful

Outcome of the vetting process.

Debe ser uno de:successfulunsuccessful

message

string

ejemploVetting finished successfully.

Human readable explanation of the vetting process result.

Ejemplo Respuesta

{
   "id": "2hothFWw2ssb3y3lhh5Fu3tzfqV",
   "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",
   "business_registration_id": "15-048-3782",
   "issuing_authority": "National Government",
   "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": "string"
   },
   "created_at": "2023-11-07T07:20:50.52Z",
   "updated_at": "2023-11-08T10:12:20.52Z",
   "delete_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": "ES",
      "city": "London",
      "province": "City of London"
   },
   "email_notifications_enabled": true,
   "change_request": null,
   "notification": {
      "created_at": "2023-11-07T07:20:50.52Z",
      "message": "This profile requires your attention. Please modify it.",
      "dismissed": true,
      "require_changes": true
   },
   "nr_notifications": 1,
   "vetting_terms_and_conditions_accepted": true,
   "vetting_extra_fields": {
      "tax_number_type": "NIF",
      "duns_number": "123456789"
   },
   "vetting_info": {
      "consent": "consented",
      "vetting_levels": [
         "standard",
         "escalated_plus"
      ]
   },
   "vetting_result": {
      "result": "successful",
      "message": "Vetting finished successfully."
   }
}

List network Business Profile registrations.

gethttps://api-eu.vonage.com/v1/network-registry/business-profiles

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Consulta Parámetros

string

Opaque token for retrieving next results page.

limit

number

Min1

Max100

Limit the number of items in the result page.

shared

boolean

Flag of shared profiles.

Respuestas
Tipo de contenido
application/json

The list of matched network Business Profile registrations.

_links

object

Requerido

Pagination info.

self

object

Requerido

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

object

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

_embedded

object

Requerido

business_profiles

array

Requerido

string

Requerido

ejemplo2hothFWw2ssb3y3lhh5Fu3tzfqV

Internal id of the Business Profile.

account_id

string

Requerido

ejemploacc102846

Internal id of account that owns the Business Profile.

countries

array

Requerido

contact_role

string

Requerido

Max100

ejemploA Business Profile

Role of the person creating the business profile.

name

string

Requerido

Max100

ejemploA Business Profile

Alias for the Network Business Profile.

trading_name

string

Max100

ejemploA Business Profile Ltd.

Network Business Profile trading name.

organisation_type

string

Requerido

Max100

ejemploforProfitOrganisation

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.

tax_number

string

Requerido

Max100

ejemplo98284687G

Business registration tax number.

business_registration_id

string

Max100

ejemplo15-048-3782

Business registration ID.

issuing_authority

string

Max100

ejemploNational Government

Business registration ID issuing authority.

privacy_policy_url

string(uri)

Requerido

Max500

ejemplohttps://www.businessinc.com/privacy_policy

Link to the business privacy policy.

privacy_policy_manager_email

string(email)

Requerido

ejemploprivacy.manager@business.com

dpo_email

string(email)

ejemplodpo@business.com

Data protection officer contact email address.

dpo_required

boolean

Flag to check if a data protection officer is required by law.

terms_and_conditions_accepted

boolean

Requerido

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

object

Requerido

status

string

Requerido

ejemploreviewed

Overall registration status of a Business Profile.

Debe ser uno de:pendingreviewedready-to-provisionprovisioningacceptedpartially-acceptedrejectedfailed

message

string

Max100

Brief description of why the Business Profile was rejected.

created_at

string(date-time)

Requerido

ejemplo2023-11-07T07:20:50.52Z

Date when the Business Profile was created.

updated_at

string(date-time)

Requerido

ejemplo2023-11-08T10:12:20.52Z

Date when the Business Profile was updated for the last time.

delete_at

string(date-time)

ejemplo2023-11-08T10:12:20.52Z

Date when the Network Application Profile request will be deleted.

business_information

object

Requerido

address_street_1

string

Requerido

Max500

ejemploMain Street 5

Address of the company.

address_street_2

string

Max500

ejemploExtra long address

Additional space to enter the address of the company.

postal_code

string

Requerido

Max500

ejemploW1 5DU

Zip/Postal Code of the company location.

country

string

Requerido

Min2

Max2

ejemploES

ISO 3166 Country short name.

city

string

Requerido

Max500

ejemploLondon

City where the company is located.

province

string

Max500

ejemploCity of London

State/Province where the company is located.

email_notifications_enabled

boolean

Flag to agree to email notifications for status updated.

change_request

object

The payload for making a change on an existing network Business Profile.

countries

array

contact_role

string

Max100

ejemploA Business Profile

Role of the person creating the business profile.

name

string

Max100

ejemploA Business Profile

Alias for the Network Business Profile.

trading_name

string

Max100

ejemploA Business Profile Ltd.

Network Business Profile trading name.

organisation_type

string

Max100

ejemploFor-Profit Organisation

Organisation type of the business.

tax_number

string

Max100

ejemplo98284687G

Business registration tax number.

business_registration_id

string

Max100

ejemplo15-048-3782

Business registration ID.

issuing_authority

string

Max100

ejemploNational Government

Business registration ID issuing authority.

privacy_policy_url

string(uri)

Max500

ejemplohttps://www.businessinc.com/privacy_policy

Link to the business privacy policy.

privacy_policy_manager_email

string(email)

ejemploprivacy.manager@business.com

dpo_email

string(email)

ejemplodpo@business.com

Data protection officer contact email address.

dpo_required

boolean

Flag to check if a data protection officer is required by law.

terms_and_conditions_accepted

boolean

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

object

address_street_1

string

Requerido

Max500

ejemploMain Street 5

Address of the company.

address_street_2

string

Max500

ejemploExtra long address

Additional space to enter the address of the company.

postal_code

string

Requerido

Max500

ejemploW1 5DU

Zip/Postal Code of the company location.

country

string

Requerido

Min2

Max2

ejemploES

ISO 3166 Country short name.

city

string

Requerido

Max500

ejemploLondon

City where the company is located.

province

string

Max500

ejemploCity of London

State/Province where the company is located.

email_notifications_enabled

boolean

Flag to agree to email notifications for status updated.

status

object

status

string

Requerido

ejemplopending

Status of change request for business profile

Debe ser uno de:rejectedpendingaccepted

message

string

Max100

Brief description of why the change request was rejected/accepted.

created_at

string(date-time)

ejemplo2023-11-07T07:20:50.52Z

Date when the Business Profile was created.

updated_at

string(date-time)

ejemplo2023-11-08T10:12:20.52Z

Date when the Business Profile was updated for the last time.

vetting_terms_and_conditions_accepted

boolean

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

object

ejemplo

{
  "tax_number_type": "NIF",
  "duns_number": "123456789"
}

Map with all the vetting fields and values required by the vetting levels that apply to the Business Profile.

notification

object

Custom Notification for a Business Profile.

created_at

string(date-time)

Requerido

ejemplo2023-11-07T07:20:50.52Z

Date when the Notification was created.

message

string

Requerido

Max1000

ejemploThis profile requires your attention. Please modify it.

Notification message.

dismissed

boolean

Requerido

Flag to indicate if this Notification has been dismissed by the User.

require_changes

boolean

Flag to indicate if this Notification will require changes performed by the User.

nr_notifications

integer

Requerido

ejemplo1

The number of non-dismissed notifications including this Business Profile and all its Application Profiles.

vetting_terms_and_conditions_accepted

boolean

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

object

ejemplo

{
  "tax_number_type": "NIF",
  "duns_number": "123456789"
}

vetting_info

object

Information regarding vetting process.

consent

string

Requerido

ejemploconsented

Acknowledgement to proceed with the vetting process.

Debe ser uno de:not_requiredconsentednot_consented

vetting_levels

array

List of vetting levels applied to the business profile at the time it was created.

vetting_result

object

Information regarding the outcome of the vetting process.

result

string

ejemplosuccessful

Outcome of the vetting process.

Debe ser uno de:successfulunsuccessful

message

string

ejemploVetting finished successfully.

Human readable explanation of the vetting process result.

Ejemplo Respuesta

{
   "_links": {
      "self": {
         "href": "https://example.com/resource?next=19284743"
      },
      "next": {
         "href": "https://example.com/resource?next=19284743"
      }
   },
   "_embedded": {
      "business_profiles": [
         {
            "id": "2hothFWw2ssb3y3lhh5Fu3tzfqV",
            "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",
            "business_registration_id": "15-048-3782",
            "issuing_authority": "National Government",
            "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": "string"
            },
            "created_at": "2023-11-07T07:20:50.52Z",
            "updated_at": "2023-11-08T10:12:20.52Z",
            "delete_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": "ES",
               "city": "London",
               "province": "City of London"
            },
            "email_notifications_enabled": true,
            "change_request": null,
            "notification": {
               "created_at": "2023-11-07T07:20:50.52Z",
               "message": "This profile requires your attention. Please modify it.",
               "dismissed": true,
               "require_changes": true
            },
            "nr_notifications": 1,
            "vetting_terms_and_conditions_accepted": true,
            "vetting_extra_fields": {
               "tax_number_type": "NIF",
               "duns_number": "123456789"
            },
            "vetting_info": {
               "consent": "consented",
               "vetting_levels": [
                  "standard",
                  "escalated_plus"
               ]
            },
            "vetting_result": {
               "result": "successful",
               "message": "Vetting finished successfully."
            }
         }
      ]
   }
}

Get a network Business Profile registration.

gethttps://api-eu.vonage.com/v1/network-registry/business-profiles/:id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

The network Business Profile id.

Respuestas
Tipo de contenido
application/json

The network Business Profile registration with the given id.

string

Requerido

ejemplo2hothFWw2ssb3y3lhh5Fu3tzfqV

Internal id of the Business Profile.

account_id

string

Requerido

ejemploacc102846

Internal id of account that owns the Business Profile.

countries

array

Requerido

contact_role

string

Requerido

Max100

ejemploA Business Profile

Role of the person creating the business profile.

name

string

Requerido

Max100

ejemploA Business Profile

Alias for the Network Business Profile.

trading_name

string

Max100

ejemploA Business Profile Ltd.

Network Business Profile trading name.

organisation_type

string

Requerido

Max100

ejemploforProfitOrganisation

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.

tax_number

string

Requerido

Max100

ejemplo98284687G

Business registration tax number.

business_registration_id

string

Max100

ejemplo15-048-3782

Business registration ID.

issuing_authority

string

Max100

ejemploNational Government

Business registration ID issuing authority.

privacy_policy_url

string(uri)

Requerido

Max500

ejemplohttps://www.businessinc.com/privacy_policy

Link to the business privacy policy.

privacy_policy_manager_email

string(email)

Requerido

ejemploprivacy.manager@business.com

dpo_email

string(email)

ejemplodpo@business.com

Data protection officer contact email address.

dpo_required

boolean

Flag to check if a data protection officer is required by law.

terms_and_conditions_accepted

boolean

Requerido

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

object

Requerido

status

string

Requerido

ejemploreviewed

Overall registration status of a Business Profile.

Debe ser uno de:pendingreviewedready-to-provisionprovisioningacceptedpartially-acceptedrejectedfailed

message

string

Max100

Brief description of why the Business Profile was rejected.

created_at

string(date-time)

Requerido

ejemplo2023-11-07T07:20:50.52Z

Date when the Business Profile was created.

updated_at

string(date-time)

Requerido

ejemplo2023-11-08T10:12:20.52Z

Date when the Business Profile was updated for the last time.

delete_at

string(date-time)

ejemplo2023-11-08T10:12:20.52Z

Date when the Network Application Profile request will be deleted.

business_information

object

Requerido

address_street_1

string

Requerido

Max500

ejemploMain Street 5

Address of the company.

address_street_2

string

Max500

ejemploExtra long address

Additional space to enter the address of the company.

postal_code

string

Requerido

Max500

ejemploW1 5DU

Zip/Postal Code of the company location.

country

string

Requerido

Min2

Max2

ejemploES

ISO 3166 Country short name.

city

string

Requerido

Max500

ejemploLondon

City where the company is located.

province

string

Max500

ejemploCity of London

State/Province where the company is located.

email_notifications_enabled

boolean

Flag to agree to email notifications for status updated.

change_request

object

The payload for making a change on an existing network Business Profile.

countries

array

contact_role

string

Max100

ejemploA Business Profile

Role of the person creating the business profile.

name

string

Max100

ejemploA Business Profile

Alias for the Network Business Profile.

trading_name

string

Max100

ejemploA Business Profile Ltd.

Network Business Profile trading name.

organisation_type

string

Max100

ejemploFor-Profit Organisation

Organisation type of the business.

tax_number

string

Max100

ejemplo98284687G

Business registration tax number.

business_registration_id

string

Max100

ejemplo15-048-3782

Business registration ID.

issuing_authority

string

Max100

ejemploNational Government

Business registration ID issuing authority.

privacy_policy_url

string(uri)

Max500

ejemplohttps://www.businessinc.com/privacy_policy

Link to the business privacy policy.

privacy_policy_manager_email

string(email)

ejemploprivacy.manager@business.com

dpo_email

string(email)

ejemplodpo@business.com

Data protection officer contact email address.

dpo_required

boolean

Flag to check if a data protection officer is required by law.

terms_and_conditions_accepted

boolean

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

object

address_street_1

string

Requerido

Max500

ejemploMain Street 5

Address of the company.

address_street_2

string

Max500

ejemploExtra long address

Additional space to enter the address of the company.

postal_code

string

Requerido

Max500

ejemploW1 5DU

Zip/Postal Code of the company location.

country

string

Requerido

Min2

Max2

ejemploES

ISO 3166 Country short name.

city

string

Requerido

Max500

ejemploLondon

City where the company is located.

province

string

Max500

ejemploCity of London

State/Province where the company is located.

email_notifications_enabled

boolean

Flag to agree to email notifications for status updated.

status

object

status

string

Requerido

ejemplopending

Status of change request for business profile

Debe ser uno de:rejectedpendingaccepted

message

string

Max100

Brief description of why the change request was rejected/accepted.

created_at

string(date-time)

ejemplo2023-11-07T07:20:50.52Z

Date when the Business Profile was created.

updated_at

string(date-time)

ejemplo2023-11-08T10:12:20.52Z

Date when the Business Profile was updated for the last time.

vetting_terms_and_conditions_accepted

boolean

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

object

ejemplo

{
  "tax_number_type": "NIF",
  "duns_number": "123456789"
}

Map with all the vetting fields and values required by the vetting levels that apply to the Business Profile.

notification

object

Custom Notification for a Business Profile.

created_at

string(date-time)

Requerido

ejemplo2023-11-07T07:20:50.52Z

Date when the Notification was created.

message

string

Requerido

Max1000

ejemploThis profile requires your attention. Please modify it.

Notification message.

dismissed

boolean

Requerido

Flag to indicate if this Notification has been dismissed by the User.

require_changes

boolean

Flag to indicate if this Notification will require changes performed by the User.

nr_notifications

integer

Requerido

ejemplo1

The number of non-dismissed notifications including this Business Profile and all its Application Profiles.

vetting_terms_and_conditions_accepted

boolean

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

object

ejemplo

{
  "tax_number_type": "NIF",
  "duns_number": "123456789"
}

vetting_info

object

Information regarding vetting process.

consent

string

Requerido

ejemploconsented

Acknowledgement to proceed with the vetting process.

Debe ser uno de:not_requiredconsentednot_consented

vetting_levels

array

List of vetting levels applied to the business profile at the time it was created.

vetting_result

object

Information regarding the outcome of the vetting process.

result

string

ejemplosuccessful

Outcome of the vetting process.

Debe ser uno de:successfulunsuccessful

message

string

ejemploVetting finished successfully.

Human readable explanation of the vetting process result.

Ejemplo Respuesta

{
   "id": "2hothFWw2ssb3y3lhh5Fu3tzfqV",
   "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",
   "business_registration_id": "15-048-3782",
   "issuing_authority": "National Government",
   "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": "string"
   },
   "created_at": "2023-11-07T07:20:50.52Z",
   "updated_at": "2023-11-08T10:12:20.52Z",
   "delete_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": "ES",
      "city": "London",
      "province": "City of London"
   },
   "email_notifications_enabled": true,
   "change_request": null,
   "notification": {
      "created_at": "2023-11-07T07:20:50.52Z",
      "message": "This profile requires your attention. Please modify it.",
      "dismissed": true,
      "require_changes": true
   },
   "nr_notifications": 1,
   "vetting_terms_and_conditions_accepted": true,
   "vetting_extra_fields": {
      "tax_number_type": "NIF",
      "duns_number": "123456789"
   },
   "vetting_info": {
      "consent": "consented",
      "vetting_levels": [
         "standard",
         "escalated_plus"
      ]
   },
   "vetting_result": {
      "result": "successful",
      "message": "Vetting finished successfully."
   }
}

Delete a network Business Profile registration.

Request the deletion of the network Business Profile registration and all its dependant Network Applications.

deletehttps://api-eu.vonage.com/v1/network-registry/business-profiles/:id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

The network Business Profile id.

Respuestas

The network Business Profile has been marked for deletion.

Dismiss the Custom Notification

Marks the Custom Notification as dismissed.

posthttps://api-eu.vonage.com/v1/network-registry/business-profiles/:id/notification/dismiss

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

The network Business Profile id.

Respuestas

The Custom Notification is marked as dismissed.

Undelete a network Business Profile registration.

Request the undeletion of the network Business Profile registration and all its dependant Network Applications.

posthttps://api-eu.vonage.com/v1/network-registry/business-profiles/:id/undelete

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

The network Business Profile id.

Respuestas

The network Business Profile has been undeleted.

Detailed information of Business Profile registration status per CSP.

gethttps://api-eu.vonage.com/v1/network-registry/business-profiles/:id/csps

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

Business Profile ID, or the literal "*" for ALL the Business Profiles

Consulta Parámetros

status

string

ejemplonot-submitted

Debe ser uno de:not-submittedwaiting-for-vettingready-to-provisionready-to-updateprovisioningacceptedrejectedfailed

string

Opaque token for retrieving next results page.

limit

number

Min1

Max100

Limit the number of items in the result page.

Respuestas
Tipo de contenido
application/json

A paginated view of the Business Profile registration status per CSP

_links

object

Requerido

Pagination info.

self

object

Requerido

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

object

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

_embedded

object

Requerido

business_profile_csp_statuses

array

Requerido

csp_id

string

Requerido

ejemplotelefonica_es

Id of the CSP

created_at

string(date-time)

Requerido

ejemplo2023-11-07T07:20:50.52Z

Date when the CSP was notified.

updated_at

string(date-time)

Requerido

ejemplo2023-11-08T10:12:20.52Z

Date when the CSP updated the status.

status

string

Requerido

ejemplonot-submitted

Registration status of a Business Profile within a CSP.

Debe ser uno de:not-submittedwaiting-for-vettingready-to-provisionready-to-updateprovisioningacceptedrejectedfailed

message

string

Max1000

ejemploSome message

Brief description of why the Business Profile was rejected by the CSP.

business_profile_id

string

Requerido

ejemplo2hothFWw2ssb3y3lhh5Fu3tzfqV

Id of the Business Profile.

account_id

string

Requerido

ejemploacc102846

Id of the Vonage Account.

Ejemplo Respuesta

{
   "_links": {
      "self": {
         "href": "https://example.com/resource?next=19284743"
      },
      "next": {
         "href": "https://example.com/resource?next=19284743"
      }
   },
   "_embedded": {
      "business_profile_csp_statuses": [
         {
            "csp_id": "telefonica_es",
            "created_at": "2023-11-07T07:20:50.52Z",
            "updated_at": "2023-11-08T10:12:20.52Z",
            "status": "not-submitted",
            "message": "Some message",
            "business_profile_id": "2hothFWw2ssb3y3lhh5Fu3tzfqV",
            "account_id": "acc102846"
         }
      ]
   }
}

Detailed information of Business Profile registration status for a given CSP.

gethttps://api-eu.vonage.com/v1/network-registry/business-profiles/:id/csps/:csp_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

The network Business Profile id.

csp_id

string

Requerido

The CSP identifier.

Respuestas
Tipo de contenido
application/json

The Business Profile registration status for the given CSP

csp_id

string

Requerido

ejemplotelefonica_es

Id of the CSP

created_at

string(date-time)

Requerido

ejemplo2023-11-07T07:20:50.52Z

Date when the CSP was notified.

updated_at

string(date-time)

Requerido

ejemplo2023-11-08T10:12:20.52Z

Date when the CSP updated the status.

status

string

Requerido

ejemplonot-submitted

Registration status of a Business Profile within a CSP.

Debe ser uno de:not-submittedwaiting-for-vettingready-to-provisionready-to-updateprovisioningacceptedrejectedfailed

message

string

Max1000

ejemploSome message

Brief description of why the Business Profile was rejected by the CSP.

business_profile_id

string

Requerido

ejemplo2hothFWw2ssb3y3lhh5Fu3tzfqV

Id of the Business Profile.

account_id

string

Requerido

ejemploacc102846

Id of the Vonage Account.

Ejemplo Respuesta

{
   "csp_id": "telefonica_es",
   "created_at": "2023-11-07T07:20:50.52Z",
   "updated_at": "2023-11-08T10:12:20.52Z",
   "status": "not-submitted",
   "message": "Some message",
   "business_profile_id": "2hothFWw2ssb3y3lhh5Fu3tzfqV",
   "account_id": "acc102846"
}

Get a list of accounts Business Profile shared with.

Get a list of accounts with which your network Business Profile has been shared

gethttps://api-eu.vonage.com/v1/network-registry/business-profiles/:id/shared

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

The network Business Profile id.

Consulta Parámetros

string

Opaque token for retrieving next results page.

limit

number

Min1

Max100

Limit the number of items in the result page.

Respuestas
Tipo de contenido
application/json

A share of network Business Profile

_links

object

Requerido

Pagination info.

self

object

Requerido

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

object

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

_embedded

object

Requerido

account_ids

array

Requerido

account_id

string

Requerido

ejemploacc102846

Id of the Vonage Account.

Ejemplo Respuesta

{
   "_links": {
      "self": {
         "href": "https://example.com/resource?next=19284743"
      },
      "next": {
         "href": "https://example.com/resource?next=19284743"
      }
   },
   "_embedded": {
      "account_ids": [
         {
            "account_id": "acc102846"
         }
      ]
   }
}

Create or update a change request

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.

puthttps://api-eu.vonage.com/v1/network-registry/business-profiles/:id/change-request

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

The network Business Profile id.

Cuerpo de la solicitud
Tipo de contenido
application/json

countries

array

contact_role

string

Max100

ejemploA Business Profile

Role of the person creating the business profile.

name

string

Max100

ejemploA Business Profile

Alias for the Network Business Profile.

trading_name

string

Max100

ejemploA Business Profile Ltd.

Network Business Profile trading name.

organisation_type

string

Max100

ejemploFor-Profit Organisation

Organisation type of the business.

tax_number

string

Max100

ejemplo98284687G

Business registration tax number.

business_registration_id

string

Max100

ejemplo15-048-3782

Business registration ID.

issuing_authority

string

Max100

ejemploNational Government

Business registration ID issuing authority.

privacy_policy_url

string(uri)

Max500

ejemplohttps://www.businessinc.com/privacy_policy

Link to the business privacy policy.

privacy_policy_manager_email

string(email)

ejemploprivacy.manager@business.com

dpo_email

string(email)

ejemplodpo@business.com

Data protection officer contact email address.

dpo_required

boolean

Flag to check if a data protection officer is required by law.

terms_and_conditions_accepted

boolean

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

object

address_street_1

string

Requerido

Max500

ejemploMain Street 5

Address of the company.

address_street_2

string

Max500

ejemploExtra long address

Additional space to enter the address of the company.

postal_code

string

Requerido

Max500

ejemploW1 5DU

Zip/Postal Code of the company location.

country

string

Requerido

Min2

Max2

ejemploES

ISO 3166 Country short name.

city

string

Requerido

Max500

ejemploLondon

City where the company is located.

province

string

Max500

ejemploCity of London

State/Province where the company is located.

email_notifications_enabled

boolean

Flag to agree to email notifications for status updated.

vetting_terms_and_conditions_accepted

boolean

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

object

ejemplo

{
  "tax_number_type": "NIF",
  "duns_number": "123456789"
}

Map with all the vetting fields and values required by the vetting levels that apply to the Business Profile.

Ejemplo Solicitar

{
   "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",
   "business_registration_id": "15-048-3782",
   "issuing_authority": "National Government",
   "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": "ES",
      "city": "London",
      "province": "City of London"
   },
   "email_notifications_enabled": true,
   "vetting_terms_and_conditions_accepted": true,
   "vetting_extra_fields": {
      "tax_number_type": "NIF",
      "duns_number": "123456789"
   }
}

{
   "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",
   "business_registration_id": "15-048-3782",
   "issuing_authority": "National Government",
   "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": "ES",
      "city": "London",
      "province": "City of London"
   },
   "email_notifications_enabled": true,
   "vetting_terms_and_conditions_accepted": true,
   "vetting_extra_fields": {
      "tax_number_type": "NIF",
      "duns_number": "123456789"
   }
}

Respuestas
Tipo de contenido
application/json

An existing change request has been updated

string

Requerido

ejemplo2hothFWw2ssb3y3lhh5Fu3tzfqV

Internal id of the Business Profile.

account_id

string

Requerido

ejemploacc102846

Internal id of account that owns the Business Profile.

countries

array

Requerido

contact_role

string

Requerido

Max100

ejemploA Business Profile

Role of the person creating the business profile.

name

string

Requerido

Max100

ejemploA Business Profile

Alias for the Network Business Profile.

trading_name

string

Max100

ejemploA Business Profile Ltd.

Network Business Profile trading name.

organisation_type

string

Requerido

Max100

ejemploforProfitOrganisation

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.

tax_number

string

Requerido

Max100

ejemplo98284687G

Business registration tax number.

business_registration_id

string

Max100

ejemplo15-048-3782

Business registration ID.

issuing_authority

string

Max100

ejemploNational Government

Business registration ID issuing authority.

privacy_policy_url

string(uri)

Requerido

Max500

ejemplohttps://www.businessinc.com/privacy_policy

Link to the business privacy policy.

privacy_policy_manager_email

string(email)

Requerido

ejemploprivacy.manager@business.com

dpo_email

string(email)

ejemplodpo@business.com

Data protection officer contact email address.

dpo_required

boolean

Flag to check if a data protection officer is required by law.

terms_and_conditions_accepted

boolean

Requerido

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

object

Requerido

status

string

Requerido

ejemploreviewed

Overall registration status of a Business Profile.

Debe ser uno de:pendingreviewedready-to-provisionprovisioningacceptedpartially-acceptedrejectedfailed

message

string

Max100

Brief description of why the Business Profile was rejected.

created_at

string(date-time)

Requerido

ejemplo2023-11-07T07:20:50.52Z

Date when the Business Profile was created.

updated_at

string(date-time)

Requerido

ejemplo2023-11-08T10:12:20.52Z

Date when the Business Profile was updated for the last time.

delete_at

string(date-time)

ejemplo2023-11-08T10:12:20.52Z

Date when the Network Application Profile request will be deleted.

business_information

object

Requerido

address_street_1

string

Requerido

Max500

ejemploMain Street 5

Address of the company.

address_street_2

string

Max500

ejemploExtra long address

Additional space to enter the address of the company.

postal_code

string

Requerido

Max500

ejemploW1 5DU

Zip/Postal Code of the company location.

country

string

Requerido

Min2

Max2

ejemploES

ISO 3166 Country short name.

city

string

Requerido

Max500

ejemploLondon

City where the company is located.

province

string

Max500

ejemploCity of London

State/Province where the company is located.

email_notifications_enabled

boolean

Flag to agree to email notifications for status updated.

change_request

object

The payload for making a change on an existing network Business Profile.

countries

array

contact_role

string

Max100

ejemploA Business Profile

Role of the person creating the business profile.

name

string

Max100

ejemploA Business Profile

Alias for the Network Business Profile.

trading_name

string

Max100

ejemploA Business Profile Ltd.

Network Business Profile trading name.

organisation_type

string

Max100

ejemploFor-Profit Organisation

Organisation type of the business.

tax_number

string

Max100

ejemplo98284687G

Business registration tax number.

business_registration_id

string

Max100

ejemplo15-048-3782

Business registration ID.

issuing_authority

string

Max100

ejemploNational Government

Business registration ID issuing authority.

privacy_policy_url

string(uri)

Max500

ejemplohttps://www.businessinc.com/privacy_policy

Link to the business privacy policy.

privacy_policy_manager_email

string(email)

ejemploprivacy.manager@business.com

dpo_email

string(email)

ejemplodpo@business.com

Data protection officer contact email address.

dpo_required

boolean

Flag to check if a data protection officer is required by law.

terms_and_conditions_accepted

boolean

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

object

address_street_1

string

Requerido

Max500

ejemploMain Street 5

Address of the company.

address_street_2

string

Max500

ejemploExtra long address

Additional space to enter the address of the company.

postal_code

string

Requerido

Max500

ejemploW1 5DU

Zip/Postal Code of the company location.

country

string

Requerido

Min2

Max2

ejemploES

ISO 3166 Country short name.

city

string

Requerido

Max500

ejemploLondon

City where the company is located.

province

string

Max500

ejemploCity of London

State/Province where the company is located.

email_notifications_enabled

boolean

Flag to agree to email notifications for status updated.

status

object

status

string

Requerido

ejemplopending

Status of change request for business profile

Debe ser uno de:rejectedpendingaccepted

message

string

Max100

Brief description of why the change request was rejected/accepted.

created_at

string(date-time)

ejemplo2023-11-07T07:20:50.52Z

Date when the Business Profile was created.

updated_at

string(date-time)

ejemplo2023-11-08T10:12:20.52Z

Date when the Business Profile was updated for the last time.

vetting_terms_and_conditions_accepted

boolean

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

object

ejemplo

{
  "tax_number_type": "NIF",
  "duns_number": "123456789"
}

Map with all the vetting fields and values required by the vetting levels that apply to the Business Profile.

notification

object

Custom Notification for a Business Profile.

created_at

string(date-time)

Requerido

ejemplo2023-11-07T07:20:50.52Z

Date when the Notification was created.

message

string

Requerido

Max1000

ejemploThis profile requires your attention. Please modify it.

Notification message.

dismissed

boolean

Requerido

Flag to indicate if this Notification has been dismissed by the User.

require_changes

boolean

Flag to indicate if this Notification will require changes performed by the User.

nr_notifications

integer

Requerido

ejemplo1

The number of non-dismissed notifications including this Business Profile and all its Application Profiles.

vetting_terms_and_conditions_accepted

boolean

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

object

ejemplo

{
  "tax_number_type": "NIF",
  "duns_number": "123456789"
}

vetting_info

object

Information regarding vetting process.

consent

string

Requerido

ejemploconsented

Acknowledgement to proceed with the vetting process.

Debe ser uno de:not_requiredconsentednot_consented

vetting_levels

array

List of vetting levels applied to the business profile at the time it was created.

vetting_result

object

Information regarding the outcome of the vetting process.

result

string

ejemplosuccessful

Outcome of the vetting process.

Debe ser uno de:successfulunsuccessful

message

string

ejemploVetting finished successfully.

Human readable explanation of the vetting process result.

Ejemplo Respuesta

{
   "id": "2hothFWw2ssb3y3lhh5Fu3tzfqV",
   "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",
   "business_registration_id": "15-048-3782",
   "issuing_authority": "National Government",
   "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": "string"
   },
   "created_at": "2023-11-07T07:20:50.52Z",
   "updated_at": "2023-11-08T10:12:20.52Z",
   "delete_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": "ES",
      "city": "London",
      "province": "City of London"
   },
   "email_notifications_enabled": true,
   "change_request": null,
   "notification": {
      "created_at": "2023-11-07T07:20:50.52Z",
      "message": "This profile requires your attention. Please modify it.",
      "dismissed": true,
      "require_changes": true
   },
   "nr_notifications": 1,
   "vetting_terms_and_conditions_accepted": true,
   "vetting_extra_fields": {
      "tax_number_type": "NIF",
      "duns_number": "123456789"
   },
   "vetting_info": {
      "consent": "consented",
      "vetting_levels": [
         "standard",
         "escalated_plus"
      ]
   },
   "vetting_result": {
      "result": "successful",
      "message": "Vetting finished successfully."
   }
}

Delete Business Profile Change Request

Deletes an existing Business Profile Change Request, returns 404 if no such change request is present

deletehttps://api-eu.vonage.com/v1/network-registry/business-profiles/:id/change-request

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

The network Business Profile id.

Respuestas

The Business Profile Change Request has been deleted

Get a list of linked Vonage Applications

Get a list of linked Vonage Applications under the Business profile

gethttps://api-eu.vonage.com/v1/network-registry/business-profiles/:id/linked-applications

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

The network Business Profile id.

Respuestas
Tipo de contenido
application/json

List of linked Vonage Applications under the business profile

_links

object

Requerido

Pagination info.

self

object

Requerido

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

object

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

_embedded

object

Requerido

linked_applications

array

Requerido

account_id

string

Requerido

ejemploacc102846

Id of the Vonage Account.

vonage_application_id

string

Requerido

ejemplod65hx4ghh

Vonage Application ID

Ejemplo Respuesta

{
   "_links": {
      "self": {
         "href": "https://example.com/resource?next=19284743"
      },
      "next": {
         "href": "https://example.com/resource?next=19284743"
      }
   },
   "_embedded": {
      "linked_applications": [
         {
            "account_id": "acc102846",
            "vonage_application_id": "d65hx4ghh"
         }
      ]
   }
}

Application Profile

Application profiles are used to define a specific use case, including which Network APIs are required and the purpose they will be used for, and will be shared with CSPs in the countries included with the associated business profile.

Operaciones disponibles

List network Application Profile registrations.

gethttps://api-eu.vonage.com/v1/network-registry/application-profiles

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Consulta Parámetros

status

string

Debe ser uno de:pendingprovisioningacceptedpartially-acceptedrejectedfailed

business_profile_id

string

Id of a Business Profile.

shared

boolean

Flag of shared profiles.

limit

number

Min1

Max100

Limit the number of items in the result page.

string

Opaque token for retrieving next results page.

Respuestas
Tipo de contenido
application/json

The list of matched network Application Profiles of the given Account.

_links

object

Requerido

Pagination info.

self

object

Requerido

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

object

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

_embedded

object

Requerido

application_profiles

array

Requerido

string

Requerido

ejemplo2hotg2Wzoy65nG6VKNaap4VFQvC

Internal id of a network Application Profile.

business_profile_id

string

Requerido

Max100

ejemplo2hothFWw2ssb3y3lhh5Fu3tzfqV

Id of the Business Profile that owns the Application Profile.

account_id

string

Requerido

Max50

ejemploacc102846

Id of the Vonage account, known as apiKey, that owns the network Application Profile.

name

string

Requerido

Max100

ejemploNetwork Application Profile

An Application Profile name

description

string

Max1000

ejemploThis Network Application Profile main use case is for Fraud Prevention

The Application use cases description.

category_id

string

Requerido

Max100

ejemplofinance

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.

Debe ser uno de:artAndDesignautoAndVehiclebeautybooksAndReferencebusinessdeveloperToolseducationeventsAndEntertainmentfinancefoodAndDrinkgameshealthAndFitnesskidslibrariesAndDemolifestylemapsAndNavigationmedicalmusicAndAudionewsAndMagazinesphotoAndVideoproductivityshoppingsocialNetworkingAndCommunicationssportsutilitiestravelAndLocalweather

status

object

Requerido

status

string

Requerido

Overall network Application Profile status.

Debe ser uno de:pendingprovisioningacceptedpartially-acceptedrejectedfailed

message

string

Max100

Brief description of why the application profile was rejected.

created_at

string(date-time)

Requerido

ejemplo2023-11-07T07:20:50.52Z

Date when the Network Application Profile request was created.

updated_at

string(date-time)

Requerido

ejemplo2023-11-08T10:12:20.52Z

Date when the Network Application Profile request was updated.

delete_at

string(date-time)

ejemplo2023-11-08T10:12:20.52Z

Date when the Network Application Profile request will be deleted.

network_apis

array

Requerido

network_api_id

string

Requerido

ejemplosim-swap

Id of the Network API. A more complete and up-to-date list of supported categories can be obtained in /v1/network-registry/catalogue/network-apis.

Sample values:

sim-swap
number-verification
device-status
qod
verify-silent-authentication

purpose_ids

array

Requerido

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.

terms_and_conditions_accepted

boolean

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

array

Requerido

notification

object

Custom Notification for an Application Profile.

created_at

string(date-time)

Requerido

ejemplo2023-11-07T07:20:50.52Z

Date when the Notification was created.

message

string

Requerido

Max1000

ejemploThis profile requires your attention. Please modify it.

Notification message.

dismissed

boolean

Requerido

Flag to indicate if this Notification has been dismissed by the User.

privacy_policy_url

string(uri)

Max500

ejemplohttps://www.businessinc.com/application_privacy_policy

Link to the application profile privacy policy.

Ejemplo Respuesta

{
   "_links": {
      "self": {
         "href": "https://example.com/resource?next=19284743"
      },
      "next": {
         "href": "https://example.com/resource?next=19284743"
      }
   },
   "_embedded": {
      "application_profiles": [
         {
            "id": "2hotg2Wzoy65nG6VKNaap4VFQvC",
            "business_profile_id": "2hothFWw2ssb3y3lhh5Fu3tzfqV",
            "account_id": "acc102846",
            "name": "Network Application Profile",
            "description": "This Network Application Profile main use case is for Fraud Prevention",
            "category_id": "finance",
            "status": {
               "status": "pending",
               "message": "string"
            },
            "created_at": "2023-11-07T07:20:50.52Z",
            "updated_at": "2023-11-08T10:12:20.52Z",
            "delete_at": "2023-11-08T10:12:20.52Z",
            "network_apis": [
               {
                  "network_api_id": "sim-swap",
                  "purpose_ids": [
                     "FraudPreventionAndDetection"
                  ]
               }
            ],
            "terms_and_conditions_accepted": true,
            "infrastructure_locations": [
               "ES"
            ],
            "notification": {
               "created_at": "2023-11-07T07:20:50.52Z",
               "message": "This profile requires your attention. Please modify it.",
               "dismissed": true
            },
            "privacy_policy_url": "https://www.businessinc.com/application_privacy_policy"
         }
      ]
   }
}

Create a new network Application Profile.

Create a new network Application Profile. There is a limit of 50 application profiles per account.

posthttps://api-eu.vonage.com/v1/network-registry/application-profiles

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Cuerpo de la solicitud
Tipo de contenido
application/json

business_profile_id

string

Requerido

Max100

ejemplo2hothFWw2ssb3y3lhh5Fu3tzfqV

Id of the Business Profile that owns the Application Profile.

name

string

Requerido

Max100

ejemploNetwork Application Profile

An Application Profile name

description

string

Max1000

ejemploThis Network Application Profile main use case is for Fraud Prevention

The Application use cases description.

category_id

string

Requerido

Max100

ejemplofinance

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.

network_apis

array

Requerido

network_api_id

string

Requerido

ejemplosim-swap

Id of the Network API. A more complete and up-to-date list of supported categories can be obtained in /v1/network-registry/catalogue/network-apis.

Sample values:

sim-swap
number-verification
device-status
qod
verify-silent-authentication

purpose_ids

array

Requerido

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.

terms_and_conditions_accepted

boolean

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

array

Requerido

privacy_policy_url

string(uri)

Max500

ejemplohttps://www.businessinc.com/application_privacy_policy

Link to the application profile privacy policy.

Ejemplo Solicitar

{
   "business_profile_id": "2hothFWw2ssb3y3lhh5Fu3tzfqV",
   "name": "Network Application Profile",
   "description": "This Network Application Profile main use case is for Fraud Prevention",
   "category_id": "finance",
   "network_apis": [
      {
         "network_api_id": "sim-swap",
         "purpose_ids": [
            "FraudPreventionAndDetection"
         ]
      }
   ],
   "terms_and_conditions_accepted": true,
   "infrastructure_locations": [
      "ES"
   ],
   "privacy_policy_url": "https://www.businessinc.com/application_privacy_policy"
}

{
   "business_profile_id": "2hothFWw2ssb3y3lhh5Fu3tzfqV",
   "name": "Network Application Profile",
   "description": "This Network Application Profile main use case is for Fraud Prevention",
   "category_id": "finance",
   "network_apis": [
      {
         "network_api_id": "sim-swap",
         "purpose_ids": [
            "FraudPreventionAndDetection"
         ]
      }
   ],
   "terms_and_conditions_accepted": true,
   "infrastructure_locations": [
      "ES"
   ],
   "privacy_policy_url": "https://www.businessinc.com/application_privacy_policy"
}

Respuestas
Tipo de contenido
application/json

The created network Application Profile.

string

Requerido

ejemplo2hotg2Wzoy65nG6VKNaap4VFQvC

Internal id of a network Application Profile.

business_profile_id

string

Requerido

Max100

ejemplo2hothFWw2ssb3y3lhh5Fu3tzfqV

Id of the Business Profile that owns the Application Profile.

account_id

string

Requerido

Max50

ejemploacc102846

Id of the Vonage account, known as apiKey, that owns the network Application Profile.

name

string

Requerido

Max100

ejemploNetwork Application Profile

An Application Profile name

description

string

Max1000

ejemploThis Network Application Profile main use case is for Fraud Prevention

The Application use cases description.

category_id

string

Requerido

Max100

ejemplofinance

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.

status

object

Requerido

status

string

Requerido

Overall network Application Profile status.

Debe ser uno de:pendingprovisioningacceptedpartially-acceptedrejectedfailed

message

string

Max100

Brief description of why the application profile was rejected.

created_at

string(date-time)

Requerido

ejemplo2023-11-07T07:20:50.52Z

Date when the Network Application Profile request was created.

updated_at

string(date-time)

Requerido

ejemplo2023-11-08T10:12:20.52Z

Date when the Network Application Profile request was updated.

delete_at

string(date-time)

ejemplo2023-11-08T10:12:20.52Z

Date when the Network Application Profile request will be deleted.

network_apis

array

Requerido

network_api_id

string

Requerido

ejemplosim-swap

Id of the Network API. A more complete and up-to-date list of supported categories can be obtained in /v1/network-registry/catalogue/network-apis.

Sample values:

sim-swap
number-verification
device-status
qod
verify-silent-authentication

purpose_ids

array

Requerido

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.

terms_and_conditions_accepted

boolean

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

array

Requerido

notification

object

Custom Notification for an Application Profile.

created_at

string(date-time)

Requerido

ejemplo2023-11-07T07:20:50.52Z

Date when the Notification was created.

message

string

Requerido

Max1000

ejemploThis profile requires your attention. Please modify it.

Notification message.

dismissed

boolean

Requerido

Flag to indicate if this Notification has been dismissed by the User.

privacy_policy_url

string(uri)

Max500

ejemplohttps://www.businessinc.com/application_privacy_policy

Link to the application profile privacy policy.

Ejemplo Respuesta

{
   "id": "2hotg2Wzoy65nG6VKNaap4VFQvC",
   "business_profile_id": "2hothFWw2ssb3y3lhh5Fu3tzfqV",
   "account_id": "acc102846",
   "name": "Network Application Profile",
   "description": "This Network Application Profile main use case is for Fraud Prevention",
   "category_id": "finance",
   "status": {
      "status": "pending",
      "message": "string"
   },
   "created_at": "2023-11-07T07:20:50.52Z",
   "updated_at": "2023-11-08T10:12:20.52Z",
   "delete_at": "2023-11-08T10:12:20.52Z",
   "network_apis": [
      {
         "network_api_id": "sim-swap",
         "purpose_ids": [
            "FraudPreventionAndDetection"
         ]
      }
   ],
   "terms_and_conditions_accepted": true,
   "infrastructure_locations": [
      "ES"
   ],
   "notification": {
      "created_at": "2023-11-07T07:20:50.52Z",
      "message": "This profile requires your attention. Please modify it.",
      "dismissed": true
   },
   "privacy_policy_url": "https://www.businessinc.com/application_privacy_policy"
}

Get network Application Profile.

Get network Application Profile

gethttps://api-eu.vonage.com/v1/network-registry/application-profiles/:id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

Network Application Profile ID

Respuestas
Tipo de contenido
application/json

A network Application Profile.

string

Requerido

ejemplo2hotg2Wzoy65nG6VKNaap4VFQvC

Internal id of a network Application Profile.

business_profile_id

string

Requerido

Max100

ejemplo2hothFWw2ssb3y3lhh5Fu3tzfqV

Id of the Business Profile that owns the Application Profile.

account_id

string

Requerido

Max50

ejemploacc102846

Id of the Vonage account, known as apiKey, that owns the network Application Profile.

name

string

Requerido

Max100

ejemploNetwork Application Profile

An Application Profile name

description

string

Max1000

ejemploThis Network Application Profile main use case is for Fraud Prevention

The Application use cases description.

category_id

string

Requerido

Max100

ejemplofinance

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.

status

object

Requerido

status

string

Requerido

Overall network Application Profile status.

Debe ser uno de:pendingprovisioningacceptedpartially-acceptedrejectedfailed

message

string

Max100

Brief description of why the application profile was rejected.

created_at

string(date-time)

Requerido

ejemplo2023-11-07T07:20:50.52Z

Date when the Network Application Profile request was created.

updated_at

string(date-time)

Requerido

ejemplo2023-11-08T10:12:20.52Z

Date when the Network Application Profile request was updated.

delete_at

string(date-time)

ejemplo2023-11-08T10:12:20.52Z

Date when the Network Application Profile request will be deleted.

network_apis

array

Requerido

network_api_id

string

Requerido

ejemplosim-swap

Id of the Network API. A more complete and up-to-date list of supported categories can be obtained in /v1/network-registry/catalogue/network-apis.

Sample values:

sim-swap
number-verification
device-status
qod
verify-silent-authentication

purpose_ids

array

Requerido

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.

terms_and_conditions_accepted

boolean

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

array

Requerido

notification

object

Custom Notification for an Application Profile.

created_at

string(date-time)

Requerido

ejemplo2023-11-07T07:20:50.52Z

Date when the Notification was created.

message

string

Requerido

Max1000

ejemploThis profile requires your attention. Please modify it.

Notification message.

dismissed

boolean

Requerido

Flag to indicate if this Notification has been dismissed by the User.

privacy_policy_url

string(uri)

Max500

ejemplohttps://www.businessinc.com/application_privacy_policy

Link to the application profile privacy policy.

Ejemplo Respuesta

{
   "id": "2hotg2Wzoy65nG6VKNaap4VFQvC",
   "business_profile_id": "2hothFWw2ssb3y3lhh5Fu3tzfqV",
   "account_id": "acc102846",
   "name": "Network Application Profile",
   "description": "This Network Application Profile main use case is for Fraud Prevention",
   "category_id": "finance",
   "status": {
      "status": "pending",
      "message": "string"
   },
   "created_at": "2023-11-07T07:20:50.52Z",
   "updated_at": "2023-11-08T10:12:20.52Z",
   "delete_at": "2023-11-08T10:12:20.52Z",
   "network_apis": [
      {
         "network_api_id": "sim-swap",
         "purpose_ids": [
            "FraudPreventionAndDetection"
         ]
      }
   ],
   "terms_and_conditions_accepted": true,
   "infrastructure_locations": [
      "ES"
   ],
   "notification": {
      "created_at": "2023-11-07T07:20:50.52Z",
      "message": "This profile requires your attention. Please modify it.",
      "dismissed": true
   },
   "privacy_policy_url": "https://www.businessinc.com/application_privacy_policy"
}

Delete a network Application Profile.

Delete network Application Profile

deletehttps://api-eu.vonage.com/v1/network-registry/application-profiles/:id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

Network Application Profile ID

Respuestas

The application profile has been marked for deletion.

Dismiss the Custom Notification

Marks the Custom Notification as dismissed.

posthttps://api-eu.vonage.com/v1/network-registry/application-profiles/:id/notification/dismiss

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

Network Application Profile ID

Respuestas

The Custom Notification is marked as dismissed.

Undelete network Application Profile.

Undelete network Application Profile

posthttps://api-eu.vonage.com/v1/network-registry/application-profiles/:id/undelete

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

Network Application Profile ID

Respuestas

The application profile has been undeleted.

Detailed information of Application Profile registration status per CSP.

gethttps://api-eu.vonage.com/v1/network-registry/application-profiles/:id/csps

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

Network Application Profile ID, or the literal "*" for ALL the Applications

Consulta Parámetros

string

Opaque token for retrieving next results page.

limit

number

Min1

Max100

Limit the number of items in the result page.

plmn_id

string

Min14

Max15

Filter list of CSP statuses by PLMN id.

status

string

ejemplonot-submitted

Filter list of the CSP statuses by status.

Debe ser uno de:not-submittedready-for-provisioningready-to-updateprovisioning-applicationapplication-acceptedprovisioning-orderacceptedrejectedfailed

csp_id

string

Filter list of CSP statuses by csp_id

Respuestas
Tipo de contenido
application/json

A paginated view of the Application Profile registration status per CSP

_links

object

Requerido

Pagination info.

self

object

Requerido

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

object

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

_embedded

object

Requerido

application_profile_csp_statuses

array

Requerido

csp_id

string

Requerido

ejemplotelefonica_es

Id of the CSP.

created_at

string(date-time)

Requerido

ejemplo2023-11-07T07:20:50.52Z

Date when the CSP was notified.

updated_at

string(date-time)

Requerido

ejemplo2023-11-08T10:12:20.52Z

Date when the CSP updated the status.

delete_at

string(date-time)

ejemplo2023-11-08T10:12:20.52Z

Date when the Network Application Profile request will be deleted.

status

string

Requerido

ejemplonot-submitted

Registration status of a Application Profile within a CSP.

Debe ser uno de:not-submittedready-for-provisioningready-to-updateprovisioning-applicationapplication-acceptedprovisioning-orderacceptedrejectedfailed

previous_status

string

ejemplonot-submitted

Registration status of a Application Profile within a CSP.

Debe ser uno de:not-submittedready-for-provisioningready-to-updateprovisioning-applicationapplication-acceptedprovisioning-orderacceptedrejectedfailed

message

string

ejemploSome message

Brief description of why the Application Profile was rejected by the CSP.

application_profile_id

string

Requerido

ejemplo2hotg2Wzoy65nG6VKNaap4VFQvC

Id of the Application Profile.

business_profile_id

string

Requerido

ejemplo2hothFWw2ssb3y3lhh5Fu3tzfqV

Id of the Business Profile.

account_id

string

Requerido

ejemploacc102846

Id of the Vonage Account.

allowlist_check_required

boolean

If this CSP requires verifying if the number is whitelisted in GNP Allowlist.

network_apis

array

List of the ids of the Network APIs used by this Application Profile.

connectivity_status

string

Connectivity status

Debe ser uno de:UNKNOWNOKERROR

Ejemplo Respuesta

{
   "_links": {
      "self": {
         "href": "https://example.com/resource?next=19284743"
      },
      "next": {
         "href": "https://example.com/resource?next=19284743"
      }
   },
   "_embedded": {
      "application_profile_csp_statuses": [
         {
            "csp_id": "telefonica_es",
            "created_at": "2023-11-07T07:20:50.52Z",
            "updated_at": "2023-11-08T10:12:20.52Z",
            "delete_at": "2023-11-08T10:12:20.52Z",
            "status": "not-submitted",
            "previous_status": "not-submitted",
            "message": "Some message",
            "application_profile_id": "2hotg2Wzoy65nG6VKNaap4VFQvC",
            "business_profile_id": "2hothFWw2ssb3y3lhh5Fu3tzfqV",
            "account_id": "acc102846",
            "allowlist_check_required": false,
            "network_apis": [
               "sim-swap",
               "number-verification"
            ],
            "connectivity_status": "UNKNOWN"
         }
      ]
   }
}

Share network Application Profile.

Share network Application Profile

posthttps://api-eu.vonage.com/v1/network-registry/application-profiles/:id/shared

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

Network Application Profile ID

Cuerpo de la solicitud
Tipo de contenido
application/json

Ejemplo Solicitar

{}

{}

Respuestas

A network Application Profile shared.

Get a list of accounts network Application Profile shared with.

Get a list of accounts with which your network Application Profile has been shared

gethttps://api-eu.vonage.com/v1/network-registry/application-profiles/:id/shared

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

Network Application Profile ID

Consulta Parámetros

string

Opaque token for retrieving next results page.

limit

number

Min1

Max100

Limit the number of items in the result page.

Respuestas
Tipo de contenido
application/json

A share of network Application Profile

_links

object

Requerido

Pagination info.

self

object

Requerido

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

object

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

_embedded

object

Requerido

account_ids

array

Requerido

account_id

string

Requerido

ejemploacc102846

Id of the Vonage Account.

Ejemplo Respuesta

{
   "_links": {
      "self": {
         "href": "https://example.com/resource?next=19284743"
      },
      "next": {
         "href": "https://example.com/resource?next=19284743"
      }
   },
   "_embedded": {
      "account_ids": [
         {
            "account_id": "acc102846"
         }
      ]
   }
}

Unshare network Application Profile.

Unshare network Application Profile

deletehttps://api-eu.vonage.com/v1/network-registry/application-profiles/:id/shared/:account_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

Network Application Profile ID

account_id

string

Requerido

Id of the Vonage Account.

Respuestas

The application profile has been unshared.

Get a list of linked Vonage Applications

Get a list of linked Vonage Applications under the Application profile

gethttps://api-eu.vonage.com/v1/network-registry/application-profiles/:id/linked-applications

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

Network Application Profile ID

Respuestas
Tipo de contenido
application/json

List of linked Vonage Applications under application profile

_links

object

Requerido

Pagination info.

self

object

Requerido

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

object

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

_embedded

object

Requerido

linked_applications

array

Requerido

account_id

string

Requerido

ejemploacc102846

Id of the Vonage Account.

vonage_application_id

string

Requerido

ejemplod65hx4ghh

Vonage Application ID

Ejemplo Respuesta

{
   "_links": {
      "self": {
         "href": "https://example.com/resource?next=19284743"
      },
      "next": {
         "href": "https://example.com/resource?next=19284743"
      }
   },
   "_embedded": {
      "linked_applications": [
         {
            "account_id": "acc102846",
            "vonage_application_id": "d65hx4ghh"
         }
      ]
   }
}

Detailed information of Application Profile registration status for the given CSP.

gethttps://api-eu.vonage.com/v1/network-registry/application-profiles/:id/csps/:csp_id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

Network Application Profile ID

csp_id

string

Requerido

The CSP identifier.

Respuestas
Tipo de contenido
application/json

The Application Profile registration status for the given CSP

csp_id

string

Requerido

ejemplotelefonica_es

Id of the CSP.

created_at

string(date-time)

Requerido

ejemplo2023-11-07T07:20:50.52Z

Date when the CSP was notified.

updated_at

string(date-time)

Requerido

ejemplo2023-11-08T10:12:20.52Z

Date when the CSP updated the status.

delete_at

string(date-time)

ejemplo2023-11-08T10:12:20.52Z

Date when the Network Application Profile request will be deleted.

status

string

Requerido

ejemplonot-submitted

Registration status of a Application Profile within a CSP.

Debe ser uno de:not-submittedready-for-provisioningready-to-updateprovisioning-applicationapplication-acceptedprovisioning-orderacceptedrejectedfailed

previous_status

string

ejemplonot-submitted

Registration status of a Application Profile within a CSP.

Debe ser uno de:not-submittedready-for-provisioningready-to-updateprovisioning-applicationapplication-acceptedprovisioning-orderacceptedrejectedfailed

message

string

ejemploSome message

Brief description of why the Application Profile was rejected by the CSP.

application_profile_id

string

Requerido

ejemplo2hotg2Wzoy65nG6VKNaap4VFQvC

Id of the Application Profile.

business_profile_id

string

Requerido

ejemplo2hothFWw2ssb3y3lhh5Fu3tzfqV

Id of the Business Profile.

account_id

string

Requerido

ejemploacc102846

Id of the Vonage Account.

allowlist_check_required

boolean

If this CSP requires verifying if the number is whitelisted in GNP Allowlist.

network_apis

array

List of the ids of the Network APIs used by this Application Profile.

connectivity_status

string

Connectivity status

Debe ser uno de:UNKNOWNOKERROR

Ejemplo Respuesta

{
   "csp_id": "telefonica_es",
   "created_at": "2023-11-07T07:20:50.52Z",
   "updated_at": "2023-11-08T10:12:20.52Z",
   "delete_at": "2023-11-08T10:12:20.52Z",
   "status": "not-submitted",
   "previous_status": "not-submitted",
   "message": "Some message",
   "application_profile_id": "2hotg2Wzoy65nG6VKNaap4VFQvC",
   "business_profile_id": "2hothFWw2ssb3y3lhh5Fu3tzfqV",
   "account_id": "acc102846",
   "allowlist_check_required": false,
   "network_apis": [
      "sim-swap",
      "number-verification"
   ],
   "connectivity_status": "UNKNOWN"
}

Catalogue

These endpoints are used to operate with different resources such as countries, categories organization types or purposes.

Operaciones disponibles

List supported countries.

gethttps://api-eu.vonage.com/v1/network-registry/catalogue/countries

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Consulta Parámetros

string

Opaque token for retrieving next results page.

Respuestas
Tipo de contenido
application/json

The list of supported countries.

_links

object

Requerido

Pagination info.

self

object

Requerido

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

object

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

_embedded

object

Requerido

countries

array

Requerido

code

string

Requerido

Min2

Max2

ejemploES

ISO 3166 Country short name.

name

string

Requerido

ejemploSpain

The country display name (in English).

Ejemplo Respuesta

{
   "_links": {
      "self": {
         "href": "https://example.com/resource?next=19284743"
      },
      "next": {
         "href": "https://example.com/resource?next=19284743"
      }
   },
   "_embedded": {
      "countries": [
         {
            "code": "ES",
            "name": "Spain"
         }
      ]
   }
}

List supported Organisation Types.

gethttps://api-eu.vonage.com/v1/network-registry/catalogue/organisation-types

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Consulta Parámetros

string

Opaque token for retrieving next results page.

Respuestas
Tipo de contenido
application/json

The list of supported Organisation Types.

_links

object

Requerido

Pagination info.

self

object

Requerido

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

object

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

_embedded

object

Requerido

organisation_types

array

Requerido

string

Requerido

ejemploforProfitOrganisation

Id of the Organisation Type.

name

string

Requerido

ejemploFor-Profit Organisation

The Organisation Type display name (in English).

Ejemplo Respuesta

{
   "_links": {
      "self": {
         "href": "https://example.com/resource?next=19284743"
      },
      "next": {
         "href": "https://example.com/resource?next=19284743"
      }
   },
   "_embedded": {
      "organisation_types": [
         {
            "id": "forProfitOrganisation",
            "name": "For-Profit Organisation"
         }
      ]
   }
}

List supported Categories.

gethttps://api-eu.vonage.com/v1/network-registry/catalogue/categories

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Consulta Parámetros

string

Opaque token for retrieving next results page.

Respuestas
Tipo de contenido
application/json

The list of supported Categories.

_links

object

Requerido

Pagination info.

self

object

Requerido

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

object

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

_embedded

object

Requerido

Ejemplo Respuesta

{
   "_links": {
      "self": {
         "href": "https://example.com/resource?next=19284743"
      },
      "next": {
         "href": "https://example.com/resource?next=19284743"
      }
   },
   "_embedded": {
      "categories": [
         {
            "id": "autoAndVehicle",
            "name": "Auto and Vehicle"
         }
      ]
   }
}

List Communications Service Providers (CSP).

gethttps://api-eu.vonage.com/v1/network-registry/catalogue/csps

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Consulta Parámetros

countries

array

Comma separated list of ISO 3166 country short codes to filter.

all

boolean

If enabled, list all the CSPs defined in the platform

string

Opaque token for retrieving next results page.

Respuestas
Tipo de contenido
application/json

The list of matched supported CSPs.

_links

object

Requerido

Pagination info.

self

object

Requerido

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

object

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

_embedded

object

Requerido

csps

array

Requerido

string

Requerido

ejemplotelefonica_es

name

string

Requerido

Max255

ejemploTelefonica

CSP Name.

country

string

Requerido

Min2

Max2

ejemploES

ISO 3166 Country short name.

supported_network_apis

array

Ids of the Network APIs supported by the CSP.

vetting_level

string

ejemplostandard_vetting

Vetting level for this CSP.

Ejemplo Respuesta

{
   "_links": {
      "self": {
         "href": "https://example.com/resource?next=19284743"
      },
      "next": {
         "href": "https://example.com/resource?next=19284743"
      }
   },
   "_embedded": {
      "csps": [
         {
            "id": "telefonica_es",
            "name": "Telefonica",
            "country": "ES",
            "supported_network_apis": [
               "sim-swap",
               "number-verification"
            ],
            "vetting_level": "standard_vetting"
         }
      ]
   }
}

List supported Network APIs.

gethttps://api-eu.vonage.com/v1/network-registry/catalogue/network-apis

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Consulta Parámetros

countries

array

Comma separated list of ISO 3166 country short codes to filter.

all

boolean

If enabled, list all the Network APIs defined in the platform

string

Opaque token for retrieving next results page.

Respuestas
Tipo de contenido
application/json

The list of supported Network APIs.

_links

object

Requerido

Pagination info.

self

object

Requerido

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

object

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

_embedded

object

Requerido

network_apis

array

Requerido

string

Requerido

ejemplosim-swap

Id of the Network API.

name

string

Requerido

ejemploSIM Swap

The Network API display name (in English).

requires

array

List of requirements of the Network API

Valores disponibles:

nv_redirect_url,qod_callback_url,verify_callback_url

Ejemplo Respuesta

{
   "_links": {
      "self": {
         "href": "https://example.com/resource?next=19284743"
      },
      "next": {
         "href": "https://example.com/resource?next=19284743"
      }
   },
   "_embedded": {
      "network_apis": [
         {
            "id": "sim-swap",
            "name": "SIM Swap",
            "requires": [
               [
                  "nv_redirect_url"
               ]
            ]
         }
      ]
   }
}

List supported Purposes.

gethttps://api-eu.vonage.com/v1/network-registry/catalogue/purposes

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Consulta Parámetros

network-apis

string

Comma separated list of Network APIs ids to filter.

string

Opaque token for retrieving next results page.

Respuestas
Tipo de contenido
application/json

The list of supported Purposes.

_links

object

Requerido

Pagination info.

self

object

Requerido

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

object

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

_embedded

object

Requerido

purposes

array

Requerido

string

Requerido

ejemplofraudPreventionAndDetection

Id of the Purpose.

name

string

Requerido

ejemploFraud Prevention and Detection

The Purpose display name (in English)

network_api_id

string

Requerido

ejemplosim-swap

Id of the Network API that the Purpose belongs to.

Ejemplo Respuesta

{
   "_links": {
      "self": {
         "href": "https://example.com/resource?next=19284743"
      },
      "next": {
         "href": "https://example.com/resource?next=19284743"
      }
   },
   "_embedded": {
      "purposes": [
         {
            "id": "fraudPreventionAndDetection",
            "name": "Fraud Prevention and Detection",
            "network_api_id": "sim-swap"
         }
      ]
   }
}

List supported Vetting levels.

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).

gethttps://api-eu.vonage.com/v1/network-registry/catalogue/vetting-levels

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Consulta Parámetros

string

Opaque token for retrieving next results page.

Respuestas
Tipo de contenido
application/json

The list of supported Vetting Levels.

_links

object

Requerido

Pagination info.

self

object

Requerido

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

object

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

_embedded

object

Requerido

vetting_levels

array

Requerido

string

Requerido

ejemplostandard_level

Id of the vetting level.

name

string

Requerido

ejemploStandard level

The vetting level display name (in English)

description

string

Requerido

ejemploStandard vetting level

Description of the vetting level.

extra_fields

array

Requerido

List of extra fields required by the vetting level

Ejemplo Respuesta

{
   "_links": {
      "self": {
         "href": "https://example.com/resource?next=19284743"
      },
      "next": {
         "href": "https://example.com/resource?next=19284743"
      }
   },
   "_embedded": {
      "vetting_levels": [
         {
            "id": "standard_level",
            "name": "Standard level",
            "description": "Standard vetting level",
            "extra_fields": [
               "legal_company_name",
               "business_registration_registrar"
            ]
         }
      ]
   }
}

Get a Vetting Level.

gethttps://api-eu.vonage.com/v1/network-registry/catalogue/vetting-levels/:id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

The Vetting Level identifier.

Respuestas
Tipo de contenido
application/json

The Vetting Level with the given id.

string

Requerido

ejemplostandard_level

Id of the vetting level.

name

string

Requerido

ejemploStandard level

The vetting level display name (in English)

description

string

Requerido

ejemploStandard vetting level

Description of the vetting level.

extra_fields

array

Requerido

List of extra fields required by the vetting level

Ejemplo Respuesta

{
   "id": "standard_level",
   "name": "Standard level",
   "description": "Standard vetting level",
   "extra_fields": [
      "legal_company_name",
      "business_registration_registrar"
   ]
}

List supported Terms and Conditions.

gethttps://api-eu.vonage.com/v1/network-registry/catalogue/terms-and-conditions

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Consulta Parámetros

string

Opaque token for retrieving next results page.

Respuestas
Tipo de contenido
application/json

The list of supported Terms and Conditions.

_links

object

Requerido

Pagination info.

self

object

Requerido

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

object

href

string

Requerido

Max4096

ejemplohttps://example.com/resource?next=19284743

URL pointing to some resource(s).

_embedded

object

Requerido

terms_and_conditions

array

Requerido

string

Requerido

ejemplogeneral

Id of the Terms and Conditions.

name

string

Requerido

ejemploGeneral terms and conditions

The Terms and Conditions display name (in English).

text

string

Requerido

ejemplo

T&Cs are determined by Network Registry. You may retrieve the latest version of those terms and 
conditions using the Network Registry T&C endpoint.

Description of the Terms and Conditions.

Ejemplo Respuesta

{
   "_links": {
      "self": {
         "href": "https://example.com/resource?next=19284743"
      },
      "next": {
         "href": "https://example.com/resource?next=19284743"
      }
   },
   "_embedded": {
      "terms_and_conditions": [
         {
            "id": "general",
            "name": "General terms and conditions",
            "text": "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"
         }
      ]
   }
}

Get Terms and Conditions.

gethttps://api-eu.vonage.com/v1/network-registry/catalogue/terms-and-conditions/:id

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

The Terms and Conditions identifier.

Respuestas
Tipo de contenido
application/json

The Terms and Conditions with the given id.

string

Requerido

ejemplogeneral

Id of the Terms and Conditions.

name

string

Requerido

ejemploGeneral terms and conditions

The Terms and Conditions display name (in English).

text

string

Requerido

ejemplo

T&Cs are determined by Network Registry. You may retrieve the latest version of those terms and 
conditions using the Network Registry T&C endpoint.

Description of the Terms and Conditions.

Ejemplo Respuesta

{
   "id": "general",
   "name": "General terms and conditions",
   "text": "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"
}

Network Registry

Business Profile

Operaciones disponibles

Create a new network Business Profile registration.

Autenticación

Cuerpo de la solicitud Tipo de contenidoapplication/json

Ejemplo Solicitar

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

List network Business Profile registrations.

Autenticación

Consulta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Get a network Business Profile registration.

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Delete a network Business Profile registration.

Autenticación

Ruta Parámetros

Respuestas

Dismiss the Custom Notification

Autenticación

Ruta Parámetros

Respuestas

Undelete a network Business Profile registration.

Autenticación

Ruta Parámetros

Respuestas

Detailed information of Business Profile registration status per CSP.

Autenticación

Ruta Parámetros

Consulta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Detailed information of Business Profile registration status for a given CSP.

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Get a list of accounts Business Profile shared with.

Autenticación

Ruta Parámetros

Consulta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Create or update a change request

Autenticación

Ruta Parámetros

Cuerpo de la solicitud Tipo de contenidoapplication/json

Ejemplo Solicitar

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Delete Business Profile Change Request

Autenticación

Ruta Parámetros

Respuestas

Get a list of linked Vonage Applications

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Application Profile

Operaciones disponibles

List network Application Profile registrations.

Autenticación

Consulta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Create a new network Application Profile.

Autenticación

Cuerpo de la solicitud Tipo de contenidoapplication/json

Ejemplo Solicitar

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Get network Application Profile.

Autenticación

Ruta Parámetros

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json