Sign in
Verify

Create a Verify profile

Creates a new Verify profile to associate verifications with.

post/verify_profiles

Request body

namestring required
languagestring
webhook_urlstring
webhook_failover_urlstring
daily_spend_limit_enabledboolean

Whether the daily spend limit is enforced for this verify profile.

daily_spend_limitnumber

The maximum daily spend allowed on this verify profile, in USD.

Example request

{
  "name": "Test Profile",
  "language": "en-US",
  "webhook_url": "http://example.com/webhook",
  "webhook_failover_url": "http://example.com/webhook/failover",
  "sms": {
    "messaging_template_id": "0abb5b4f-459f-445a-bfcd-488998b7572d",
    "app_name": "Example Secure App",
    "code_length": 6,
    "whitelisted_destinations": [
      "US",
      "CA"
    ],
    "default_verification_timeout_secs": 300
  },
  "call": {
    "messaging_template_id": "0abb5b4f-459f-445a-bfcd-488998b7572d",
    "app_name": "Example Secure App",
    "code_length": 6,
    "whitelisted_destinations": [
      "US",
      "CA"
    ],
    "default_verification_timeout_secs": 300
  },
  "flashcall": {
    "whitelisted_destinations": [
      "US",
      "CA"
    ],
    "app_name": "Example Secure App",
    "default_verification_timeout_secs": 300
  },
  "whatsapp": {
    "whitelisted_destinations": [
      "US",
      "CA"
    ],
    "default_verification_timeout_secs": 300,
    "waba_id": "1234567890",
    "sender_phone_number": "+13035551234",
    "template_id": "authentication_template_name"
  },
  "daily_spend_limit_enabled": true,
  "daily_spend_limit": 100
}

Response

Expected Verify profile response to a valid request.

Example response

{
  "data": {
    "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    "name": "Test Profile",
    "webhook_url": "http://example.com/webhook",
    "webhook_failover_url": "http://example.com/webhook/failover",
    "daily_spend_limit_enabled": true,
    "daily_spend_limit": 100,
    "record_type": "verification_profile",
    "created_at": "2020-09-14T17:03:32.965812",
    "updated_at": "2020-09-14T17:03:32.965812",
    "language": "en-US",
    "sms": {
      "messaging_template_id": "0abb5b4f-459f-445a-bfcd-488998b7572d",
      "app_name": "Example Secure App",
      "code_length": 6,
      "whitelisted_destinations": [
        "US",
        "CA"
      ],
      "default_verification_timeout_secs": 300
    },
    "call": {
      "messaging_template_id": "0abb5b4f-459f-445a-bfcd-488998b7572d",
      "app_name": "Example Secure App",
      "code_length": 6,
      "whitelisted_destinations": [
        "US",
        "CA"
      ],
      "default_verification_timeout_secs": 300
    },
    "flashcall": {
      "app_name": "Example Secure App",
      "default_verification_timeout_secs": 300
    },
    "whatsapp": {
      "messaging_template_id": "0abb5b4f-459f-445a-bfcd-488998b7572d",
      "app_name": "Example Secure App",
      "code_length": 6,
      "whitelisted_destinations": [
        "US",
        "CA"
      ],
      "default_verification_timeout_secs": 300,
      "waba_id": "1234567890",
      "sender_phone_number": "+13035551234",
      "template_id": "authentication_template_name"
    }
  }
}

Changes

Changed in 2 of the 47 revisions of this API.38

  • 30cb1ddce91b24See the full diff
    • ●

      removed the request property rcs

      request-property-removed

    • ●

      removed the optional property data/rcs from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional request property daily_spend_limit

      new-optional-request-property

    • ○

      added the new optional request property daily_spend_limit_enabled

      new-optional-request-property

    • ○

      added the optional property data/daily_spend_limit to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/daily_spend_limit_enabled to the response with the 200 status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1b9d5c4ac1a614See the full diff
    • ●

      removed the request property whatsapp/app_name

      request-property-removed

    • ○

      added the new optional request property whatsapp/sender_phone_number

      new-optional-request-property

    • ○

      added the new optional request property whatsapp/template_id

      new-optional-request-property

    • ○

      added the new optional request property whatsapp/waba_id

      new-optional-request-property

    • ○

      added the optional property data/whatsapp to the response with the 200 status

      response-optional-property-added