List all Verify profiles

gethttps://api.telnyx.com/v2/verify_profiles

Gets a paginated list of Verify profiles.

curl -X GET \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "Authorization: Bearer YOUR_API_KEY" \ --globoff "https://api.telnyx.com/v2/verify_profiles?filter[name]=test&page[size]=25"

Parameters

In Query
filter[name]
string
optional
Optional filter for profile names.
page[size]
integer
optional
Default:
25
page[number]
integer
optional
Default:
1

Responses

200
Expected Verify profile response to a valid request.
400
Unexpected error

Success Response

{
  "data": [
    {
      "call": {
        "default_call_timeout_secs": 30,
        "default_verification_timeout_secs": 300,
        "speech_template": "Hello, this is the Acme Inc verification code you requested: {code}."
      },
      "created_at": "2020-09-14T17:03:32.965812",
      "flashcall": {
        "default_verification_timeout_secs": 300
      },
      "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
      "language": "en-US",
      "name": "Test Profile",
      "psd2": {
        "default_verification_timeout_secs": 300
      },
      "record_type": "verification_profile",
      "sms": {
        "default_verification_timeout_secs": 300,
        "messaging_enabled": true,
        "messaging_template": "Hello, this is the Acme Inc verification code you requested: {code}.",
        "rcs_enabled": true,
        "vsms_enabled": true
      },
      "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",
        "default_verification_timeout_secs": 300
      }
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

...

posthttps://api.telnyx.com/v2/verify_profiles

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/verify_profiles/{verify_profile_id}

...

...

Parameters

Responses

Success Response

...

patchhttps://api.telnyx.com/v2/verify_profiles/{verify_profile_id}

...

...

Parameters

Responses

Success Response

...

deletehttps://api.telnyx.com/v2/verify_profiles/{verify_profile_id}

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/verifications/sms

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/verifications/psd2

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/verifications/call

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/verifications/flashcall

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/verifications/whatsapp

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/verifications/{verification_id}

...

...

Parameters

Responses

Success Response

...

gethttps://api.telnyx.com/v2/verifications/by_phone_number/{phone_number}

...

...

Parameters

Responses

Success Response

...

posthttps://api.telnyx.com/v2/verifications/by_phone_number/{phone_number}/actions/verify

...

...

Parameters

Responses

Success Response

Previous:
Verify
Was this page helpful?