Sign in
VerifyV2Challenge

Verify a specific Challenge.

Verify a specific Challenge.

post/v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}

Path parameters

ServiceSidstring required

The unique SID identifier of the Service.

Identitystring required

Customer 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.

Sidstring required

A 34 character string that uniquely identifies this Challenge.

Response

OK

sidstring nullable

A 34 character string that uniquely identifies this Challenge.

account_sidstring nullable

The unique SID identifier of the Account.

service_sidstring nullable

The unique SID identifier of the Service.

entity_sidstring nullable

The unique SID identifier of the Entity.

identitystring nullable

Customer 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.

factor_sidstring nullable

The unique SID identifier of the Factor.

date_createdstring date-time nullable

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

date_updatedstring date-time nullable

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

date_respondedstring date-time nullable

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

expiration_datestring date-time nullable

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'pending' | 'expired' | 'approved' | 'denied'

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

responded_reason'none' | 'not_needed' | 'not_requested'

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

{"stackTrail":"components:schemas:verify.v2.service.entity.challenge:properties:details","oasType":"schema","type":"unknown","description":"Details provided to give context about the Challenge. Intended to be shown to the end user.","extensionFields":{"x-twilio":{"pii":{"handling":"standard","deleteSla":30}}},"nullable":true}
{"stackTrail":"components:schemas:verify.v2.service.entity.challenge:properties:hidden_details","oasType":"schema","type":"unknown","description":"Details 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\"}`","extensionFields":{"x-twilio":{"pii":{"handling":"standard","deleteSla":30}}},"nullable":true}
{"stackTrail":"components:schemas:verify.v2.service.entity.challenge:properties:metadata","oasType":"schema","type":"unknown","description":"Custom 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.","extensionFields":{"x-twilio":{"pii":{"handling":"standard","deleteSla":30}}},"nullable":true}
factor_type'push' | 'totp' | 'passkeys'

The Factor Type of this Challenge. Currently push and totp are supported.

urlstring uri nullable

The URL of this resource.

linksobject nullable

Contains a dictionary of URL links to nested resources of this Challenge.

Changes

Changed in 4 of the 52 revisions of this API.712

  • v23fd4376faab51See the full diff
    • ●

      added the new passkeys enum value to the response property for the response status

      response-property-enum-value-added

  • v21548692e680431See the full diff
    • ▲

      the response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the response's property type changed from object to no type for status

      response-property-type-changed

    • ○

      the request property type was generalized from object to no type

      request-property-type-generalized

  • v243e0e113369c4See the full diff
    • ▲

      the request property type changed from no type to object

      request-property-type-changed

    • ▲

      the response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the response's property type changed from no type to object for status

      response-property-type-changed

  • v2fb6ded97d73f1See the full diff
    • ○

      api tag VerifyV2Challenge added

      api-tag-added