Skip to main content

Create a Verify profile

POST 

/verify_profiles

Creates a new Verify profile to associate verifications with.

Request

Body

required

    name stringrequired
    webhook_url string
    webhook_failover_url string

    sms

    object

    messaging_enabled boolean

    Enables SMS text messaging for the Verify profile.

    rcs_enabled boolean

    Enables RCS messaging for the Verify profile.

    messaging_template string

    Optionally sets a messaging text template when sending the verification code. Uses {code} to template in the actual verification code.

    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.

    vsms_enabled boolean

    Enables VSMS for the Verify profile.

    psd2

    object

    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.

    whatsapp

    object

    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.

    app_name string

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

    call

    object

    msg_template string

    Optionally sets a speech text template when sending the verification code. Uses {code} to template in the actual verification code.

    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.

    default_call_timeout_secs integer

    Default value: 45

    Must be less than default_verification_timeout_secs

    flashcall

    object

    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.

Schema

    data

    object

    id uuid
    name string
    webhook_url string
    webhook_failover_url string
    record_type VerificationProfileRecordType

    Possible values: [verification_profile]

    The possible verification profile record types.

    created_at string
    updated_at string

    sms

    object

    messaging_enabled boolean

    Enables SMS text messaging for the Verify profile.

    rcs_enabled boolean

    Enables RCS messaging for the Verify profile.

    messaging_template string

    Optionally sets a messaging text template when sending the verification code. Uses {code} to template in the actual verification code.

    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.

    vsms_enabled boolean

    Enables VSMS for the Verify profile.

    psd2

    object

    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.

    whatsapp

    object

    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.

    app_name string

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

    call

    object

    messaging_template string

    Optionally sets a speech text template when sending the verification code. Uses {code} to template in the actual verification code.

    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.

    default_call_timeout_secs integer

    Default value: 45

    Must be less than default_verification_timeout_secs

    flashcall

    object

    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

400: Bad Request

Schema

    errors

    Error[]

  • Array [

  • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta

    object

    url string

    URL with additional information on the error.

  • ]

Loading...