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.
Verfügbare Operationen
Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
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.
100A Business ProfileRole of the person creating the business profile.
100A Business ProfileAlias for the Network Business Profile.
100A Business Profile Ltd.Network Business Profile trading name.
100forProfitOrganisationOrganisation 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.
academicScientificOrganisationforProfitOrganisationgovernmentalOrganisationindustryConsortiuminternationalOrganisationnonProfitOrganisationnonGovernmentalOrganisationorganisationalUnit10098284687GBusiness registration tax number.
10015-048-3782Business registration ID.
100National GovernmentBusiness registration ID issuing authority.
500https://www.businessinc.com/privacy_policyLink to the business privacy policy.
privacy.manager@business.comPrivacy policy manager contact email address.
dpo@business.comData protection officer contact email address.
Flag to check if a data protection officer is required by law.
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.
500Main Street 5Address of the company.
500Extra long addressAdditional space to enter the address of the company.
500W1 5DUZip/Postal Code of the company location.
22ESISO 3166 Country short name.
500LondonCity where the company is located.
500City of LondonState/Province where the company is located.
Flag to agree to email notifications for status updated.
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.
{
"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.
Beispiel Anfrage
{
"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"
}
}2hothFWw2ssb3y3lhh5Fu3tzfqVInternal id of the Business Profile.
acc102846Internal id of account that owns the Business Profile.
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.
100A Business ProfileRole of the person creating the business profile.
100A Business ProfileAlias for the Network Business Profile.
100A Business Profile Ltd.Network Business Profile trading name.
100forProfitOrganisationOrganisation 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.
academicScientificOrganisationforProfitOrganisationgovernmentalOrganisationindustryConsortiuminternationalOrganisationnonProfitOrganisationnonGovernmentalOrganisationorganisationalUnit10098284687GBusiness registration tax number.
10015-048-3782Business registration ID.
100National GovernmentBusiness registration ID issuing authority.
500https://www.businessinc.com/privacy_policyLink to the business privacy policy.
privacy.manager@business.comPrivacy policy manager contact email address.
dpo@business.comData protection officer contact email address.
Flag to check if a data protection officer is required by law.
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.
reviewedOverall registration status of a Business Profile.
pendingreviewedready-to-provisionprovisioningacceptedpartially-acceptedrejectedfailed100Brief description of why the Business Profile was rejected.
2023-11-07T07:20:50.52ZDate when the Business Profile was created.
2023-11-08T10:12:20.52ZDate when the Business Profile was updated for the last time.
2023-11-08T10:12:20.52ZDate when the Network Application Profile request will be deleted.
500Main Street 5Address of the company.
500Extra long addressAdditional space to enter the address of the company.
500W1 5DUZip/Postal Code of the company location.
22ESISO 3166 Country short name.
500LondonCity where the company is located.
500City of LondonState/Province where the company is located.
Flag to agree to email notifications for status updated.
The payload for making a change on an existing network Business Profile.
100A Business ProfileRole of the person creating the business profile.
100A Business ProfileAlias for the Network Business Profile.
100A Business Profile Ltd.Network Business Profile trading name.
100For-Profit OrganisationOrganisation type of the business.
10098284687GBusiness registration tax number.
10015-048-3782Business registration ID.
100National GovernmentBusiness registration ID issuing authority.
500https://www.businessinc.com/privacy_policyLink to the business privacy policy.
privacy.manager@business.comPrivacy policy manager contact email address.
dpo@business.comData protection officer contact email address.
Flag to check if a data protection officer is required by law.
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.
500Main Street 5Address of the company.
500Extra long addressAdditional space to enter the address of the company.
500W1 5DUZip/Postal Code of the company location.
22ESISO 3166 Country short name.
500LondonCity where the company is located.
500City of LondonState/Province where the company is located.
Flag to agree to email notifications for status updated.
pendingStatus of change request for business profile
rejectedpendingaccepted100Brief description of why the change request was rejected/accepted.
2023-11-07T07:20:50.52ZDate when the Business Profile was created.
2023-11-08T10:12:20.52ZDate when the Business Profile was updated for the last time.
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.
{
"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.
Custom Notification for a Business Profile.
2023-11-07T07:20:50.52ZDate when the Notification was created.
1000This profile requires your attention. Please modify it.Notification message.
Flag to indicate if this Notification has been dismissed by the User.
Flag to indicate if this Notification will require changes performed by the User.
1The number of non-dismissed notifications including this Business Profile and all its Application Profiles.
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.
{
"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.
Information regarding vetting process.
consentedAcknowledgement to proceed with the vetting process.
not_requiredconsentednot_consentedList of vetting levels applied to the business profile at the time it was created.
Information regarding the outcome of the vetting process.
successfulOutcome of the vetting process.
successfulunsuccessfulVetting finished successfully.Human readable explanation of the vetting process result.
Beispiel Antwort
{
"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."
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Pagination info.
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
2hothFWw2ssb3y3lhh5Fu3tzfqVInternal id of the Business Profile.
acc102846Internal id of account that owns the Business Profile.
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.
100A Business ProfileRole of the person creating the business profile.
100A Business ProfileAlias for the Network Business Profile.
100A Business Profile Ltd.Network Business Profile trading name.
100forProfitOrganisationOrganisation 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.
academicScientificOrganisationforProfitOrganisationgovernmentalOrganisationindustryConsortiuminternationalOrganisationnonProfitOrganisationnonGovernmentalOrganisationorganisationalUnit10098284687GBusiness registration tax number.
10015-048-3782Business registration ID.
100National GovernmentBusiness registration ID issuing authority.
500https://www.businessinc.com/privacy_policyLink to the business privacy policy.
privacy.manager@business.comPrivacy policy manager contact email address.
dpo@business.comData protection officer contact email address.
Flag to check if a data protection officer is required by law.
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.
reviewedOverall registration status of a Business Profile.
pendingreviewedready-to-provisionprovisioningacceptedpartially-acceptedrejectedfailed100Brief description of why the Business Profile was rejected.
2023-11-07T07:20:50.52ZDate when the Business Profile was created.
2023-11-08T10:12:20.52ZDate when the Business Profile was updated for the last time.
2023-11-08T10:12:20.52ZDate when the Network Application Profile request will be deleted.
500Main Street 5Address of the company.
500Extra long addressAdditional space to enter the address of the company.
500W1 5DUZip/Postal Code of the company location.
22ESISO 3166 Country short name.
500LondonCity where the company is located.
500City of LondonState/Province where the company is located.
Flag to agree to email notifications for status updated.
The payload for making a change on an existing network Business Profile.
100A Business ProfileRole of the person creating the business profile.
100A Business ProfileAlias for the Network Business Profile.
100A Business Profile Ltd.Network Business Profile trading name.
100For-Profit OrganisationOrganisation type of the business.
10098284687GBusiness registration tax number.
10015-048-3782Business registration ID.
100National GovernmentBusiness registration ID issuing authority.
500https://www.businessinc.com/privacy_policyLink to the business privacy policy.
privacy.manager@business.comPrivacy policy manager contact email address.
dpo@business.comData protection officer contact email address.
Flag to check if a data protection officer is required by law.
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.
500Main Street 5Address of the company.
500Extra long addressAdditional space to enter the address of the company.
500W1 5DUZip/Postal Code of the company location.
22ESISO 3166 Country short name.
500LondonCity where the company is located.
500City of LondonState/Province where the company is located.
Flag to agree to email notifications for status updated.
pendingStatus of change request for business profile
rejectedpendingaccepted100Brief description of why the change request was rejected/accepted.
2023-11-07T07:20:50.52ZDate when the Business Profile was created.
2023-11-08T10:12:20.52ZDate when the Business Profile was updated for the last time.
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.
{
"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.
Custom Notification for a Business Profile.
2023-11-07T07:20:50.52ZDate when the Notification was created.
1000This profile requires your attention. Please modify it.Notification message.
Flag to indicate if this Notification has been dismissed by the User.
Flag to indicate if this Notification will require changes performed by the User.
1The number of non-dismissed notifications including this Business Profile and all its Application Profiles.
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.
{
"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.
Information regarding vetting process.
consentedAcknowledgement to proceed with the vetting process.
not_requiredconsentednot_consentedList of vetting levels applied to the business profile at the time it was created.
Information regarding the outcome of the vetting process.
successfulOutcome of the vetting process.
successfulunsuccessfulVetting finished successfully.Human readable explanation of the vetting process result.
Beispiel Antwort
{
"_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."
}
}
]
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
2hothFWw2ssb3y3lhh5Fu3tzfqVInternal id of the Business Profile.
acc102846Internal id of account that owns the Business Profile.
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.
100A Business ProfileRole of the person creating the business profile.
100A Business ProfileAlias for the Network Business Profile.
100A Business Profile Ltd.Network Business Profile trading name.
100forProfitOrganisationOrganisation 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.
academicScientificOrganisationforProfitOrganisationgovernmentalOrganisationindustryConsortiuminternationalOrganisationnonProfitOrganisationnonGovernmentalOrganisationorganisationalUnit10098284687GBusiness registration tax number.
10015-048-3782Business registration ID.
100National GovernmentBusiness registration ID issuing authority.
500https://www.businessinc.com/privacy_policyLink to the business privacy policy.
privacy.manager@business.comPrivacy policy manager contact email address.
dpo@business.comData protection officer contact email address.
Flag to check if a data protection officer is required by law.
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.
reviewedOverall registration status of a Business Profile.
pendingreviewedready-to-provisionprovisioningacceptedpartially-acceptedrejectedfailed100Brief description of why the Business Profile was rejected.
2023-11-07T07:20:50.52ZDate when the Business Profile was created.
2023-11-08T10:12:20.52ZDate when the Business Profile was updated for the last time.
2023-11-08T10:12:20.52ZDate when the Network Application Profile request will be deleted.
500Main Street 5Address of the company.
500Extra long addressAdditional space to enter the address of the company.
500W1 5DUZip/Postal Code of the company location.
22ESISO 3166 Country short name.
500LondonCity where the company is located.
500City of LondonState/Province where the company is located.
Flag to agree to email notifications for status updated.
The payload for making a change on an existing network Business Profile.
100A Business ProfileRole of the person creating the business profile.
100A Business ProfileAlias for the Network Business Profile.
100A Business Profile Ltd.Network Business Profile trading name.
100For-Profit OrganisationOrganisation type of the business.
10098284687GBusiness registration tax number.
10015-048-3782Business registration ID.
100National GovernmentBusiness registration ID issuing authority.
500https://www.businessinc.com/privacy_policyLink to the business privacy policy.
privacy.manager@business.comPrivacy policy manager contact email address.
dpo@business.comData protection officer contact email address.
Flag to check if a data protection officer is required by law.
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.
500Main Street 5Address of the company.
500Extra long addressAdditional space to enter the address of the company.
500W1 5DUZip/Postal Code of the company location.
22ESISO 3166 Country short name.
500LondonCity where the company is located.
500City of LondonState/Province where the company is located.
Flag to agree to email notifications for status updated.
pendingStatus of change request for business profile
rejectedpendingaccepted100Brief description of why the change request was rejected/accepted.
2023-11-07T07:20:50.52ZDate when the Business Profile was created.
2023-11-08T10:12:20.52ZDate when the Business Profile was updated for the last time.
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.
{
"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.
Custom Notification for a Business Profile.
2023-11-07T07:20:50.52ZDate when the Notification was created.
1000This profile requires your attention. Please modify it.Notification message.
Flag to indicate if this Notification has been dismissed by the User.
Flag to indicate if this Notification will require changes performed by the User.
1The number of non-dismissed notifications including this Business Profile and all its Application Profiles.
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.
{
"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.
Information regarding vetting process.
consentedAcknowledgement to proceed with the vetting process.
not_requiredconsentednot_consentedList of vetting levels applied to the business profile at the time it was created.
Information regarding the outcome of the vetting process.
successfulOutcome of the vetting process.
successfulunsuccessfulVetting finished successfully.Human readable explanation of the vetting process result.
Beispiel Antwort
{
"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."
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Abfrage Parameter
not-submittednot-submittedwaiting-for-vettingready-to-provisionready-to-updateprovisioningacceptedrejectedfailedOpaque token for retrieving next results page.
1100Limit the number of items in the result page.
Pagination info.
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
telefonica_esId of the CSP
2023-11-07T07:20:50.52ZDate when the CSP was notified.
2023-11-08T10:12:20.52ZDate when the CSP updated the status.
not-submittedRegistration status of a Business Profile within a CSP.
not-submittedwaiting-for-vettingready-to-provisionready-to-updateprovisioningacceptedrejectedfailed1000Some messageBrief description of why the Business Profile was rejected by the CSP.
2hothFWw2ssb3y3lhh5Fu3tzfqVId of the Business Profile.
acc102846Id of the Vonage Account.
Beispiel Antwort
{
"_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"
}
]
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
telefonica_esId of the CSP
2023-11-07T07:20:50.52ZDate when the CSP was notified.
2023-11-08T10:12:20.52ZDate when the CSP updated the status.
not-submittedRegistration status of a Business Profile within a CSP.
not-submittedwaiting-for-vettingready-to-provisionready-to-updateprovisioningacceptedrejectedfailed1000Some messageBrief description of why the Business Profile was rejected by the CSP.
2hothFWw2ssb3y3lhh5Fu3tzfqVId of the Business Profile.
acc102846Id of the Vonage Account.
Beispiel Antwort
{
"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"
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Pagination info.
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
acc102846Id of the Vonage Account.
Beispiel Antwort
{
"_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.
Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
100A Business ProfileRole of the person creating the business profile.
100A Business ProfileAlias for the Network Business Profile.
100A Business Profile Ltd.Network Business Profile trading name.
100For-Profit OrganisationOrganisation type of the business.
10098284687GBusiness registration tax number.
10015-048-3782Business registration ID.
100National GovernmentBusiness registration ID issuing authority.
500https://www.businessinc.com/privacy_policyLink to the business privacy policy.
privacy.manager@business.comPrivacy policy manager contact email address.
dpo@business.comData protection officer contact email address.
Flag to check if a data protection officer is required by law.
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.
500Main Street 5Address of the company.
500Extra long addressAdditional space to enter the address of the company.
500W1 5DUZip/Postal Code of the company location.
22ESISO 3166 Country short name.
500LondonCity where the company is located.
500City of LondonState/Province where the company is located.
Flag to agree to email notifications for status updated.
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.
{
"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.
Beispiel Anfrage
{
"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"
}
}2hothFWw2ssb3y3lhh5Fu3tzfqVInternal id of the Business Profile.
acc102846Internal id of account that owns the Business Profile.
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.
100A Business ProfileRole of the person creating the business profile.
100A Business ProfileAlias for the Network Business Profile.
100A Business Profile Ltd.Network Business Profile trading name.
100forProfitOrganisationOrganisation 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.
academicScientificOrganisationforProfitOrganisationgovernmentalOrganisationindustryConsortiuminternationalOrganisationnonProfitOrganisationnonGovernmentalOrganisationorganisationalUnit10098284687GBusiness registration tax number.
10015-048-3782Business registration ID.
100National GovernmentBusiness registration ID issuing authority.
500https://www.businessinc.com/privacy_policyLink to the business privacy policy.
privacy.manager@business.comPrivacy policy manager contact email address.
dpo@business.comData protection officer contact email address.
Flag to check if a data protection officer is required by law.
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.
reviewedOverall registration status of a Business Profile.
pendingreviewedready-to-provisionprovisioningacceptedpartially-acceptedrejectedfailed100Brief description of why the Business Profile was rejected.
2023-11-07T07:20:50.52ZDate when the Business Profile was created.
2023-11-08T10:12:20.52ZDate when the Business Profile was updated for the last time.
2023-11-08T10:12:20.52ZDate when the Network Application Profile request will be deleted.
500Main Street 5Address of the company.
500Extra long addressAdditional space to enter the address of the company.
500W1 5DUZip/Postal Code of the company location.
22ESISO 3166 Country short name.
500LondonCity where the company is located.
500City of LondonState/Province where the company is located.
Flag to agree to email notifications for status updated.
The payload for making a change on an existing network Business Profile.
100A Business ProfileRole of the person creating the business profile.
100A Business ProfileAlias for the Network Business Profile.
100A Business Profile Ltd.Network Business Profile trading name.
100For-Profit OrganisationOrganisation type of the business.
10098284687GBusiness registration tax number.
10015-048-3782Business registration ID.
100National GovernmentBusiness registration ID issuing authority.
500https://www.businessinc.com/privacy_policyLink to the business privacy policy.
privacy.manager@business.comPrivacy policy manager contact email address.
dpo@business.comData protection officer contact email address.
Flag to check if a data protection officer is required by law.
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.
500Main Street 5Address of the company.
500Extra long addressAdditional space to enter the address of the company.
500W1 5DUZip/Postal Code of the company location.
22ESISO 3166 Country short name.
500LondonCity where the company is located.
500City of LondonState/Province where the company is located.
Flag to agree to email notifications for status updated.
pendingStatus of change request for business profile
rejectedpendingaccepted100Brief description of why the change request was rejected/accepted.
2023-11-07T07:20:50.52ZDate when the Business Profile was created.
2023-11-08T10:12:20.52ZDate when the Business Profile was updated for the last time.
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.
{
"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.
Custom Notification for a Business Profile.
2023-11-07T07:20:50.52ZDate when the Notification was created.
1000This profile requires your attention. Please modify it.Notification message.
Flag to indicate if this Notification has been dismissed by the User.
Flag to indicate if this Notification will require changes performed by the User.
1The number of non-dismissed notifications including this Business Profile and all its Application Profiles.
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.
{
"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.
Information regarding vetting process.
consentedAcknowledgement to proceed with the vetting process.
not_requiredconsentednot_consentedList of vetting levels applied to the business profile at the time it was created.
Information regarding the outcome of the vetting process.
successfulOutcome of the vetting process.
successfulunsuccessfulVetting finished successfully.Human readable explanation of the vetting process result.
Beispiel Antwort
{
"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."
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Pagination info.
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
acc102846Id of the Vonage Account.
d65hx4ghhVonage Application ID
Beispiel Antwort
{
"_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"
}
]
}
}Verfügbare Operationen
Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Abfrage Parameter
pendingprovisioningacceptedpartially-acceptedrejectedfailedId of a Business Profile.
Flag of shared profiles.
1100Limit the number of items in the result page.
Opaque token for retrieving next results page.
Pagination info.
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
2hotg2Wzoy65nG6VKNaap4VFQvCInternal id of a network Application Profile.
1002hothFWw2ssb3y3lhh5Fu3tzfqVId of the Business Profile that owns the Application Profile.
50acc102846Id of the Vonage account, known as apiKey, that owns the network Application Profile.
100Network Application ProfileAn Application Profile name
1000This Network Application Profile main use case is for Fraud PreventionThe Application use cases description.
100financeA 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.
artAndDesignautoAndVehiclebeautybooksAndReferencebusinessdeveloperToolseducationeventsAndEntertainmentfinancefoodAndDrinkgameshealthAndFitnesskidslibrariesAndDemolifestylemapsAndNavigationmedicalmusicAndAudionewsAndMagazinesphotoAndVideoproductivityshoppingsocialNetworkingAndCommunicationssportsutilitiestravelAndLocalweatherOverall network Application Profile status.
pendingprovisioningacceptedpartially-acceptedrejectedfailed100Brief description of why the application profile was rejected.
2023-11-07T07:20:50.52ZDate when the Network Application Profile request was created.
2023-11-08T10:12:20.52ZDate when the Network Application Profile request was updated.
2023-11-08T10:12:20.52ZDate when the Network Application Profile request will be deleted.
sim-swapId 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
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.
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.
Custom Notification for an Application Profile.
2023-11-07T07:20:50.52ZDate when the Notification was created.
1000This profile requires your attention. Please modify it.Notification message.
Flag to indicate if this Notification has been dismissed by the User.
500https://www.businessinc.com/application_privacy_policyLink to the application profile privacy policy.
Beispiel Antwort
{
"_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"
}
]
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
1002hothFWw2ssb3y3lhh5Fu3tzfqVId of the Business Profile that owns the Application Profile.
100Network Application ProfileAn Application Profile name
1000This Network Application Profile main use case is for Fraud PreventionThe Application use cases description.
100financeA 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.
artAndDesignautoAndVehiclebeautybooksAndReferencebusinessdeveloperToolseducationeventsAndEntertainmentfinancefoodAndDrinkgameshealthAndFitnesskidslibrariesAndDemolifestylemapsAndNavigationmedicalmusicAndAudionewsAndMagazinesphotoAndVideoproductivityshoppingsocialNetworkingAndCommunicationssportsutilitiestravelAndLocalweathersim-swapId 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
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.
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.
500https://www.businessinc.com/application_privacy_policyLink to the application profile privacy policy.
Beispiel Anfrage
{
"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"
}2hotg2Wzoy65nG6VKNaap4VFQvCInternal id of a network Application Profile.
1002hothFWw2ssb3y3lhh5Fu3tzfqVId of the Business Profile that owns the Application Profile.
50acc102846Id of the Vonage account, known as apiKey, that owns the network Application Profile.
100Network Application ProfileAn Application Profile name
1000This Network Application Profile main use case is for Fraud PreventionThe Application use cases description.
100financeA 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.
artAndDesignautoAndVehiclebeautybooksAndReferencebusinessdeveloperToolseducationeventsAndEntertainmentfinancefoodAndDrinkgameshealthAndFitnesskidslibrariesAndDemolifestylemapsAndNavigationmedicalmusicAndAudionewsAndMagazinesphotoAndVideoproductivityshoppingsocialNetworkingAndCommunicationssportsutilitiestravelAndLocalweatherOverall network Application Profile status.
pendingprovisioningacceptedpartially-acceptedrejectedfailed100Brief description of why the application profile was rejected.
2023-11-07T07:20:50.52ZDate when the Network Application Profile request was created.
2023-11-08T10:12:20.52ZDate when the Network Application Profile request was updated.
2023-11-08T10:12:20.52ZDate when the Network Application Profile request will be deleted.
sim-swapId 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
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.
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.
Custom Notification for an Application Profile.
2023-11-07T07:20:50.52ZDate when the Notification was created.
1000This profile requires your attention. Please modify it.Notification message.
Flag to indicate if this Notification has been dismissed by the User.
500https://www.businessinc.com/application_privacy_policyLink to the application profile privacy policy.
Beispiel Antwort
{
"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"
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
2hotg2Wzoy65nG6VKNaap4VFQvCInternal id of a network Application Profile.
1002hothFWw2ssb3y3lhh5Fu3tzfqVId of the Business Profile that owns the Application Profile.
50acc102846Id of the Vonage account, known as apiKey, that owns the network Application Profile.
100Network Application ProfileAn Application Profile name
1000This Network Application Profile main use case is for Fraud PreventionThe Application use cases description.
100financeA 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.
artAndDesignautoAndVehiclebeautybooksAndReferencebusinessdeveloperToolseducationeventsAndEntertainmentfinancefoodAndDrinkgameshealthAndFitnesskidslibrariesAndDemolifestylemapsAndNavigationmedicalmusicAndAudionewsAndMagazinesphotoAndVideoproductivityshoppingsocialNetworkingAndCommunicationssportsutilitiestravelAndLocalweatherOverall network Application Profile status.
pendingprovisioningacceptedpartially-acceptedrejectedfailed100Brief description of why the application profile was rejected.
2023-11-07T07:20:50.52ZDate when the Network Application Profile request was created.
2023-11-08T10:12:20.52ZDate when the Network Application Profile request was updated.
2023-11-08T10:12:20.52ZDate when the Network Application Profile request will be deleted.
sim-swapId 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
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.
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.
Custom Notification for an Application Profile.
2023-11-07T07:20:50.52ZDate when the Notification was created.
1000This profile requires your attention. Please modify it.Notification message.
Flag to indicate if this Notification has been dismissed by the User.
500https://www.businessinc.com/application_privacy_policyLink to the application profile privacy policy.
Beispiel Antwort
{
"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"
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Abfrage Parameter
Opaque token for retrieving next results page.
1100Limit the number of items in the result page.
1415Filter list of CSP statuses by PLMN id.
not-submittedFilter list of the CSP statuses by status.
not-submittedready-for-provisioningready-to-updateprovisioning-applicationapplication-acceptedprovisioning-orderacceptedrejectedfailedFilter list of CSP statuses by csp_id
Pagination info.
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
telefonica_esId of the CSP.
2023-11-07T07:20:50.52ZDate when the CSP was notified.
2023-11-08T10:12:20.52ZDate when the CSP updated the status.
2023-11-08T10:12:20.52ZDate when the Network Application Profile request will be deleted.
not-submittedRegistration status of a Application Profile within a CSP.
not-submittedready-for-provisioningready-to-updateprovisioning-applicationapplication-acceptedprovisioning-orderacceptedrejectedfailednot-submittedRegistration status of a Application Profile within a CSP.
not-submittedready-for-provisioningready-to-updateprovisioning-applicationapplication-acceptedprovisioning-orderacceptedrejectedfailedSome messageBrief description of why the Application Profile was rejected by the CSP.
2hotg2Wzoy65nG6VKNaap4VFQvCId of the Application Profile.
2hothFWw2ssb3y3lhh5Fu3tzfqVId of the Business Profile.
acc102846Id of the Vonage Account.
If this CSP requires verifying if the number is whitelisted in GNP Allowlist.
List of the ids of the Network APIs used by this Application Profile.
Connectivity status
UNKNOWNOKERRORBeispiel Antwort
{
"_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"
}
]
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Pagination info.
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
acc102846Id of the Vonage Account.
Beispiel Antwort
{
"_links": {
"self": {
"href": "https://example.com/resource?next=19284743"
},
"next": {
"href": "https://example.com/resource?next=19284743"
}
},
"_embedded": {
"account_ids": [
{
"account_id": "acc102846"
}
]
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Pagination info.
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
acc102846Id of the Vonage Account.
d65hx4ghhVonage Application ID
Beispiel Antwort
{
"_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"
}
]
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
telefonica_esId of the CSP.
2023-11-07T07:20:50.52ZDate when the CSP was notified.
2023-11-08T10:12:20.52ZDate when the CSP updated the status.
2023-11-08T10:12:20.52ZDate when the Network Application Profile request will be deleted.
not-submittedRegistration status of a Application Profile within a CSP.
not-submittedready-for-provisioningready-to-updateprovisioning-applicationapplication-acceptedprovisioning-orderacceptedrejectedfailednot-submittedRegistration status of a Application Profile within a CSP.
not-submittedready-for-provisioningready-to-updateprovisioning-applicationapplication-acceptedprovisioning-orderacceptedrejectedfailedSome messageBrief description of why the Application Profile was rejected by the CSP.
2hotg2Wzoy65nG6VKNaap4VFQvCId of the Application Profile.
2hothFWw2ssb3y3lhh5Fu3tzfqVId of the Business Profile.
acc102846Id of the Vonage Account.
If this CSP requires verifying if the number is whitelisted in GNP Allowlist.
List of the ids of the Network APIs used by this Application Profile.
Connectivity status
UNKNOWNOKERRORBeispiel Antwort
{
"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"
}Verfügbare Operationen
Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Pagination info.
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
22ESISO 3166 Country short name.
SpainThe country display name (in English).
Beispiel Antwort
{
"_links": {
"self": {
"href": "https://example.com/resource?next=19284743"
},
"next": {
"href": "https://example.com/resource?next=19284743"
}
},
"_embedded": {
"countries": [
{
"code": "ES",
"name": "Spain"
}
]
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Pagination info.
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
forProfitOrganisationId of the Organisation Type.
For-Profit OrganisationThe Organisation Type display name (in English).
Beispiel Antwort
{
"_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"
}
]
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Pagination info.
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
autoAndVehicleId of the Category.
Auto and VehicleThe Category display name (in English).
Beispiel Antwort
{
"_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"
}
]
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Pagination info.
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
telefonica_es255TelefonicaCSP Name.
22ESISO 3166 Country short name.
Ids of the Network APIs supported by the CSP.
standard_vettingVetting level for this CSP.
Beispiel Antwort
{
"_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"
}
]
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Pagination info.
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
sim-swapId of the Network API.
SIM SwapThe Network API display name (in English).
List of requirements of the Network API
nv_redirect_url,qod_callback_url,verify_callback_urlBeispiel Antwort
{
"_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"
]
]
}
]
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Pagination info.
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
fraudPreventionAndDetectionId of the Purpose.
Fraud Prevention and DetectionThe Purpose display name (in English)
sim-swapId of the Network API that the Purpose belongs to.
Beispiel Antwort
{
"_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).
Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Pagination info.
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
standard_levelId of the vetting level.
Standard levelThe vetting level display name (in English)
Standard vetting levelDescription of the vetting level.
List of extra fields required by the vetting level
Beispiel Antwort
{
"_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"
]
}
]
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
standard_levelId of the vetting level.
Standard levelThe vetting level display name (in English)
Standard vetting levelDescription of the vetting level.
List of extra fields required by the vetting level
Beispiel Antwort
{
"id": "standard_level",
"name": "Standard level",
"description": "Standard vetting level",
"extra_fields": [
"legal_company_name",
"business_registration_registrar"
]
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
Pagination info.
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
4096https://example.com/resource?next=19284743URL pointing to some resource(s).
generalId of the Terms and Conditions.
General terms and conditionsThe Terms and Conditions display name (in English).
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.
Beispiel Antwort
{
"_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"
}
]
}
}Authentifizierung
| Schlüssel | Beschreibung | Wo | Beispiel |
|---|---|---|---|
| Authorization | Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. | Headers | Basic <base64> |
generalId of the Terms and Conditions.
General terms and conditionsThe Terms and Conditions display name (in English).
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.
Beispiel Antwort
{
"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"
}