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.

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`	文字列 PII MTL: 30 DAYS Customer unique identity for the Entity owner of the Challenge
`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`	オブジェクト PII MTL: 30 DAYS Details provided to give context about the Challenge. Intended to be shown to the end user.
`hidden_details`	オブジェクト PII MTL: 30 DAYS 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 in REST API format
`service_sid` Path	post sid<VA> Not PII The unique SID identifier of the Service.
`identity` Path	post 文字列 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.
`factor_sid` 必須	post sid<YF> Not PII The unique SID identifier of the Factor.
`expiration_date` オプション	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` オプション	post 文字列 Not PII Shown to the user when the push notification arrives. Required when `factor_type` is `push`
`details.fields` オプション	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` オプション	post オブジェクト 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"}`

例 1

Loading Code Sample...

Next Sample

Show sample response

Example JSON API response

Create Challenge

Fetch a Challenge resource

GET

https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}

パラメーター

Parameters in REST API format

service_sid

Path

GET sid<VA> Not PII

The unique SID identifier of the Service.

identity

Path

GET 文字列 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.

sid

Path

GET sid<YC> Not PII

A 34 character string that uniquely identifies this Challenge.

例 1

Loading Code Sample...

Next Sample

Show sample response

Example JSON API response

Fetch Challenge

Read multiple Challenge resources

GET

https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges

パラメーター

Parameters in REST API format
`service_sid` Path	GET sid<VA> Not PII The unique SID identifier of the Service.
`identity` Path	GET 文字列 PII MTL: 30 DAYS Customer unique identity for the Entity owner of the Challenge
`factor_sid` オプション	GET sid<YF> Not PII The unique SID identifier of the Factor.
`status` オプション	GET ienum:challenge_statuses Not PII The Status of the Challenges to fetch. One of `pending`, `expired`, `approved` or `denied`.

例 1

Loading Code Sample...

Next Sample

Show sample response

Example JSON API response

Read Challenge

Update a Challenge resource

post

https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}

パラメーター

Parameters in REST API format
`service_sid` Path	post sid<VA> Not PII The unique SID identifier of the Service.
`identity` Path	post 文字列 PII MTL: 30 DAYS Customer unique identity for the Entity owner of the Challenge
`sid` Path	post sid<YC> Not PII A 34 character string that uniquely identifies this Challenge.
`auth_payload` オプション	post 文字列 Not PII The optional payload needed to verify the Challenge. E.g., a TOTP would use the numeric code.