Skip to main content

Update Verify profile

PATCH 
/verify_profiles/:verify_profile_id

Update Verify profile

Request

Path Parameters

    verify_profile_id uuidrequired

    The identifier of the Verify profile to update.

Body

required

    name string
    webhook_url string
    webhook_failover_url string

    sms

    object

    messaging_template_id uuid

    The message template identifier selected from /verify_profiles/templates

    app_name string

    Possible values: Value must match regular expression ^[A-Za-z0-9 -]{1,30}$

    The name that identifies the application requesting 2fa in the verification message.

    alpha_sender stringnullable

    Possible values: Value must match regular expression ^[A-Za-z0-9 ]{1,11}$

    The alphanumeric sender ID to use when sending to destinations that require an alphanumeric sender ID.

    whitelisted_destinations string[]

    Possible values: Value must match regular expression ^[A-Z]{2}$

    Enabled country destinations to send verification codes. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to ["*"], all destinations will be allowed.

    default_verification_timeout_secs integer

    For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.

    call

    object

    messaging_template_id uuid

    The message template identifier selected from /verify_profiles/templates

    app_name string

    Possible values: Value must match regular expression ^[A-Za-z0-9 -]{1,30}$

    The name that identifies the application requesting 2fa in the verification message.

    whitelisted_destinations string[]

    Possible values: Value must match regular expression ^[A-Z]{2}$

    Enabled country destinations to send verification codes. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to ["*"], all destinations will be allowed.

    default_verification_timeout_secs integer

    For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.

    flashcall

    object

    whitelisted_destinations string[]

    Possible values: Value must match regular expression ^[A-Z]{2}$

    Enabled country destinations to send verification codes. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to ["*"], all destinations will be allowed.

    default_verification_timeout_secs integer

    For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.

    language string

Responses

200: Expected Verify profile response to a valid request.

400: Bad Request

Loading...