Menu

Expand
Rate this page:

Challenge Resource

Verify Push is in Public Beta.

A Challenge represents a single verification attempt of an Entity using a Factor. A single Factor has multiple Challenges.

Verify Push is priced per approved/denied Challenge

pricing

While usage of Verify Push is currently free in the Private Beta release stage, we will start billing for it once it hits Public Beta. Consistent with overall Verify pricing, Verify Push will be billed at a rate of $0.05 per verification. In technical terms, a "verification" is defined as a Challenge that is updated with a status of approved or denied

Challenge properties

Resource Properties in REST API format
sid
sid<YC> Not PII

A 34 character string that uniquely identifies this Challenge.

account_sid
sid<AC> Not PII

The unique SID identifier of the Account.

service_sid
sid<VA> Not PII

The unique SID identifier of the Service.

entity_sid
sid<YE> Not PII

The unique SID identifier of the Entity.

identity

Customer unique identity for the Entity owner of the Challenge. This value must be between 8 and 64 characters long.

factor_sid
sid<YF> Not PII

The unique SID identifier of the Factor.

date_created
date_time<iso8601> Not PII

The date that this Challenge was created, given in ISO 8601 format.

date_updated
date_time<iso8601> Not PII

The date that this Challenge was updated, given in ISO 8601 format.

date_responded
date_time<iso8601> Not PII

The date that this Challenge was responded, given in ISO 8601 format.

expiration_date
date_time<iso8601> Not PII

The date-time when this Challenge expires, given in ISO 8601 format. The default value is five (5) minutes after Challenge creation. The max value is sixty (60) minutes after creation.

status
enum:challenge_statuses Not PII

The Status of this Challenge. One of pending, expired, approved or denied.

responded_reason
enum:challenge_reasons Not PII

Reason for the Challenge to be in certain status. One of none, not_needed or not_requested.

details

Details provided to give context about the Challenge. Intended to be shown to the end user.

hidden_details

Details provided to give context about the Challenge. Not intended to be shown to the end user. It must be a stringified JSON with only strings values eg. {"ip": "172.168.1.234"}

factor_type
enum:factor_types Not PII

The Factor Type of this Challenge. Currently only push is supported.

url
url Not PII

The URL of this resource.

Create a Challenge resource

post
https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges
Parameters
Parameters in REST API format
service_sid
Path
post sid<VA> Not PII

The unique SID identifier of the Service.

identity
Path
post string PII MTL: 30 DAYS

The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, and generated by your external system, such as your user's UUID, GUID, or SID. This value must be between 8 and 64 characters long.

factor_sid
Required
post sid<YF> Not PII

The unique SID identifier of the Factor.

expiration_date
Optional
post date_time<iso8601> Not PII

The date-time when this Challenge expires, given in ISO 8601 format. The default value is five (5) minutes after Challenge creation. The max value is sixty (60) minutes after creation.

details.message
Optional
post string Not PII

Shown to the user when the push notification arrives. Required when factor_type is push

details.fields
Optional
post object[] Not PII

A list of objects that describe the Fields included in the Challenge. Each object contains the label and value of the field. Used when factor_type is push.

hidden_details
Optional
post object PII MTL: 30 DAYS

Details provided to give context about the Challenge. Not shown to the end user. It must be a stringified JSON with only strings values eg. {"ip": "172.168.1.234"}

Example 1
        
        
        
        

        Fetch a Challenge resource

        get
        https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}
        Parameters
        Parameters in REST API format
        service_sid
        Path
        get sid<VA> Not PII

        The unique SID identifier of the Service.

        identity
        Path
        get string PII MTL: 30 DAYS

        The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, and generated by your external system, such as your user's UUID, GUID, or SID. This value must be between 8 and 64 characters long.

        sid
        Path
        get sid<YC> Not PII

        A 34 character string that uniquely identifies this Challenge.

        Example 1
              
              
              
              

              Read multiple Challenge resources

              get
              https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges
              Parameters
              Parameters in REST API format
              service_sid
              Path
              get sid<VA> Not PII

              The unique SID identifier of the Service.

              identity
              Path
              get string PII MTL: 30 DAYS

              Customer unique identity for the Entity owner of the Challenge. This value must be between 8 and 64 characters long.

              factor_sid
              Optional
              get sid<YF> Not PII

              The unique SID identifier of the Factor.

              status
              Optional
              get ienum:challenge_statuses Not PII

              The Status of the Challenges to fetch. One of pending, expired, approved or denied.

              Example 1
                    
                    
                    
                    

                    Update a Challenge resource

                    post
                    https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}
                    Parameters
                    Parameters in REST API format
                    service_sid
                    Path
                    post sid<VA> Not PII

                    The unique SID identifier of the Service.

                    identity
                    Path
                    post string PII MTL: 30 DAYS

                    Customer unique identity for the Entity owner of the Challenge. This value must be between 8 and 64 characters long.

                    sid
                    Path
                    post sid<YC> Not PII

                    A 34 character string that uniquely identifies this Challenge.

                    auth_payload
                    Optional
                    post string Not PII

                    The optional payload needed to verify the Challenge. E.g., a TOTP would use the numeric code.

                    Example 1
                          
                          
                          
                          
                          Rate this page:

                          Need some help?

                          We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.

                                
                                
                                

                                Thank you for your feedback!

                                We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

                                Sending your feedback...
                                🎉 Thank you for your feedback!
                                Something went wrong. Please try again.

                                Thanks for your feedback!

                                Refer us and get $10 in 3 simple steps!

                                Step 1

                                Get link

                                Get a free personal referral link here

                                Step 2

                                Give $10

                                Your user signs up and upgrade using link

                                Step 3

                                Get $10

                                1,250 free SMSes
                                OR 1,000 free voice mins
                                OR 12,000 chats
                                OR more