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

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"
    ],
    "app_name": "Example Secure App",
    "default_verification_timeout_secs": 300
  },
  "rcs": {
    "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,
    "sms_fallback": true
  }
}

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",
    "record_type": "verification_profile",
    "created_at": "2020-09-14T17:03:32.965812",
    "updated_at": "2020-09-14T17:03:32.965812",
    "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
    },
    "language": "en-US",
    "rcs": {
      "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,
      "sms_fallback": true
    }
  }
}

Changes