Sign in

v1

latestOpenAPI 3.0.22026-07-1481521.0 KB
Configuration

Register an email sender

Register an email sender with an API Key for using email with Verify V2.

post/account/register-sender

Query parameters

api_keystring required
Example:abcd1234

Your Vonage API key. You can find this in the dashboard

api_secretstring required
Example:ABCDEFGH01234abc

Your Vonage API secret. You can find this in the dashboard

Request body

application_idsobject

An optional array of additional ApplicationID's that the value is to be assigned to.

namestring

An optional name to be attached to this binding

provider'email' enum required

The delivery method by which the value would be assigned. Always email

valuestring email required

The email adress to attach to the application(s)

Example request

{
  "name": "my-email-link",
  "provider": "email",
  "value": "bob@company.com"
}

Response

OK

application_idsstring[]

An array of ApplicationID strings attached to the value provided.

namestring

An optional name to be attached to this binding

provider'email' enum

Enum identifer of provider type.

valuestring

Value given to the provider to attach to the Application IDs.

Example response

{
  "application_ids": [
    "6ec9eb7de1d34e77ac2c0ad597c9554a",
    "5dba5838689f402dba0c77957e2181f3"
  ],
  "name": "optionalName",
  "provider": "email",
  "value": "alice@company.com"
}