Network Enablement

The Network Enablement API improves the existing authentication flow for Network APIs. This is especially beneficial for those APIs using client authentication, such as the Number Verification API, increasing performance, privacy and security:

Télécharger la spécification OpenAPI

NetworkEnablement

facilitates the integration of the Network APIs.

Opérations disponibles

Handle network enablement requests

Handle network enablement requests

Initiates the usage of Network APIs

posthttps://api-eu.vonage.com/v0.1/network-enablement

Authentification

Clé	Description	Où	Exemple
Authorization	Votre jeton web JSON. En savoir plus sur les JWT	Headers	`Bearer <JWT>`

Corps de la demande
Type de contenu
application/json

phone_number

string

Exigée

exemple+442072068888

The phone number that will be used to authenticate the user.

scopes

array

Exigée

List of scopes used during the authentication process to define the specific actions a user is allowed to access.

state

string

Exigée

exempletests-state-b3977c55-b4caa

A random string to identify each access token you generate.

Exemple Demande

{
   "phone_number": "+442072068888",
   "scopes": [
      "dpv:FraudPreventionAndDetection#number-verification-verify-read"
   ],
   "state": "tests-state-b3977c55-b4caa"
}

{
   "phone_number": "+442072068888",
   "scopes": [
      "dpv:FraudPreventionAndDetection#number-verification-verify-read"
   ],
   "state": "tests-state-b3977c55-b4caa"
}

Réponses
Type de contenu
application/json

scopes

object

Requested scope responses

dpv:FraudPreventionAndDetection#number-verification-verify-read

L'un des

app_url

string

[deprecated] If present, will always be null.

auth_url

string

Contains the URL to be sent to the frontend to start the authorization flow

requires_carrier_network

boolean

[deprecated] Indicates that the call to auth_url must be made over the carrier network, rather than via Wifi. If present, always true.

Exemple Réponse

{
   "scopes": {
      "dpv:FraudPreventionAndDetection#number-verification-verify-read": {
         "app_url": null,
         "auth_url": "https://api-eu.vonage.com/oauth2/auth",
         "requires_carrier_network": true
      },
      "dpv:FrandPreventionAndDetection#example-error-scope": {
         "error": {
            "title": "Forbidden",
            "instance": "bf0ca0-bf927b-3b52e3cb-03217e1a1ddf",
            "detail": "The Network API application can only be used with verified phone numbers. Blocked by allowlist.",
            "error_type": "UNAUTHORIZED"
         }
      }
   }
}

Network Enablement