Vonage · Example Payload

Vonage Requestverification Example

Example request and response for initiating a verification via the Vonage Verify API.

CommunicationMessagingTelecommunicationsVideo ConferencingVoiceSMSVerification

Vonage Requestverification Example is an example object payload from Vonage, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

summarydescriptionrequestresponse

Example Payload

{
  "summary": "Request a phone number verification",
  "description": "Example request and response for initiating a verification via the Vonage Verify API.",
  "request": {
    "method": "POST",
    "url": "https://api.nexmo.com/verify/json",
    "headers": {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    "body": {
      "api_key": "{{VONAGE_API_KEY}}",
      "api_secret": "{{VONAGE_API_SECRET}}",
      "number": "14155550100",
      "brand": "MyApp",
      "code_length": 6
    }
  },
  "response": {
    "status": 200,
    "body": {
      "request_id": "abcdef0123456789abcdef0123456789",
      "status": "0"
    }
  }
}