The Challenge resource is currently used by Verify Push and Verify TOTP features. It represents a single verification attempt of an Entity using a Factor. When the factor_type is push, a Challenge is created to verify the signature of the message sent from the registered device with the public key stored in the Factor. When the factor_type is totp, a Challenge is created to verify that the TOTP code provided by the user matches the one generated by the seed stored in the Factor. Some Challenge properties apply to all factor_types and others do not. A single Entity links to multiple Factors and a single Factor links to multiple Challenges.
Verify Push
Consistent with overall Verify pricing, Verify Push is billed at a rate of $0.05 per verification. In technical terms, a Verify Push "verification" is defined as a Challenge of factor_type:push that is updated with a status of approved or denied.
Verify TOTP
Consistent with overall Verify pricing, Verify TOTP will be billed at a rate of $0.05 per verification. In technical terms, a Verify TOTP "verification" is defined as a Challenge of factor_type:totp that is updated with a status of approved.
identitytype: stringCustomer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
date_createdtype: string<date-time>The date that this Challenge was created, given in ISO 8601 format.
date_updatedtype: string<date-time>The date that this Challenge was updated, given in ISO 8601 format.
date_respondedtype: string<date-time>The date that this Challenge was responded, given in ISO 8601 format.
expiration_datetype: string<date-time>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.
statustype: enum<string>The Status of this Challenge. One of pending, expired, approved or denied.
pendingexpiredapproveddeniedresponded_reasontype: enum<string>Reason for the Challenge to be in certain status. One of none, not_needed or not_requested.
nonenot_needednot_requesteddetailstype: objectDetails provided to give context about the Challenge. Intended to be shown to the end user.
hidden_detailstype: objectDetails provided to give context about the Challenge. Intended to be hidden from the end user. It must be a stringified JSON with only strings values eg. {"ip": "172.168.1.234"}
metadatatype: objectCustom metadata associated with the challenge. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. {"os": "Android"}. Can be up to 1024 characters in length.
factor_typetype: enum<string>The Factor Type of this Challenge. Currently push and totp are supported.
pushtotplinkstype: object<uri-map>Contains a dictionary of URL links to nested resources of this Challenge.
POST https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/ChallengesIdentitytype: stringCustomer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
ExpirationDatetype: string<date-time>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.Messagetype: stringShown to the user when the push notification arrives. Required when factor_type is push. Can be up to 256 characters in length
Details.Fieldstype: arrayA list of objects that describe the Fields included in the Challenge. Each object contains the label and value of the field, the label can be up to 36 characters in length and the value can be up to 128 characters in length. Used when factor_type is push. There can be up to 20 details fields.
HiddenDetailstype: objectDetails 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"}. Can be up to 1024 characters in length
AuthPayloadtype: stringOptional payload used to verify the Challenge upon creation. Only used with a Factor of type totp to carry the TOTP code that needs to be verified. For TOTP this value must be between 3 and 8 characters long.
GET https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}Identitytype: stringCustomer unique identity for the Entity owner of the Challenges. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
GET https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/ChallengesIdentitytype: stringCustomer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
Statustype: enum<string>The Status of the Challenges to fetch. One of pending, expired, approved or denied.
pendingexpiredapproveddeniedOrdertype: enum<string>The desired sort order of the Challenges list. One of asc or desc for ascending and descending respectively. Defaults to asc.
ascdescPageSizetype: integerHow many resources to return in each list page. The default is 50, and the maximum is 1000.
POST https://verify.twilio.com/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}Identitytype: stringCustomer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
AuthPayloadtype: stringThe optional payload needed to verify the Challenge. E.g., a TOTP would use the numeric code. For TOTP this value must be between 3 and 8 characters long. For Push this value can be up to 5456 characters in length
Metadatatype: objectCustom metadata associated with the challenge. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. {"os": "Android"}. Can be up to 1024 characters in length.