Sign in
Verify

Retrieve Verify profile

Returns the details of a single Verify profile by its ID, including its verification channel configuration.

get/verify_profiles/{verify_profile_id}

Path parameters

verify_profile_idstring uuid required
Example:12ade33a-21c0-473b-b055-b3c836e1c292

The identifier of the Verify profile to retrieve.

Response

Expected Verify profile response to a valid request.

Example response

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

Changes

Changed in 2 of the 61 revisions of this API.211

  • 1571b0380bd711See the full diff
    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 400

      response-property-type-changed

    • ○

      added the optional property errors/items/meta/url to the response with the 400 status

      response-optional-property-added

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

  • 8f5f4e53799411See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 400

      response-property-type-changed

    • ●

      removed the optional property errors/items/meta/url from the response with the 400 status

      response-optional-property-removed

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