Create a verification service

Before you call

Credential

Authorization: Bearer $KEY

Scope

voice:write

Graphql

Mutation.voiceVerifyServiceCreate

Sdk

verify.services.create

Cli

verify service-create

Request bodyapplication/json, required

• namestringrequired
  Shown to the person in the message: Your verification code At most 30 characters.
• enabledboolean
• codeLengthinteger
  At least 4. At most 10.
• channelslist of string
• channelOrderlist of string
  The order channel auto tries, and a fallback follows
• autoFallbackboolean
  When a send fails or is not delivered, try the next channel by itself
• codeTtlSecondsinteger
  At least 60. At most 600.
• maxSendsinteger
  At least 1. At most 5.
• maxChecksinteger
  At least 1. At most 5.
• resendCooldownSecondsinteger
  At least 0. At most 600.
• defaultCountrystring or null
• defaultLocalestring
  At most 10 characters.
• customCodeEnabledboolean
• psd2Enabledboolean
• dtmfInputRequiredboolean
• ttsNamestring or null
• doNotShareWarningboolean
• lookupFirstboolean
  Look the number up before sending: landlines get a call instead of a text and blocked line types are refused
• skipSmsToLandlinesboolean
• rateLimitslist of object
  • keystringrequired
    What the limit counts by: the destination, the caller's network address, a user id, a device id, or the whole service One of: to, ip, user, device, service.
  • maxintegerrequired
    At least 1. At most 10000.
  • intervalSecondsintegerrequired
    At least 10. At most 86400.
• fraudobject
  • allowCountrieslist of string
    Only these countries may receive a code; empty allows all
  • denyCountrieslist of string
  • blockPremiumboolean
  • blockLineTypeslist of string
    Line types from a lookup to refuse, for example voip or nonFixedVoip
  • distinctPerIpobject or null
  • sequentialGuardboolean
  • conversionGuardobject or null
• emailobject
  • fromstring (email) or null
  • fromNamestring or null
  • transportstring
    One of: auto, resend, furcate-mail, own-mta.

Responses

• 201application/json
  Success
• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring