v1

latestOpenAPI 3.0.1Apache 2.02026-07-145344123.3 KB

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

account_sidstring nullable

The unique SID identifier of the Account.

date_createdstring date-time nullable

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

date_respondedstring date-time nullable

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

date_updatedstring date-time nullable

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

{"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.","nullable":true}
entity_sidstring nullable

The unique SID identifier of the Entity.

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.

factor_sidstring nullable

The unique SID identifier of the Factor.

factor_type'push' | 'totp'
{"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\"}`","nullable":true}
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.

linksobject nullable

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

{"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.","nullable":true}
responded_reason'none' | 'not_needed' | 'not_requested'
service_sidstring nullable

The unique SID identifier of the Service.

sidstring nullable

A 34 character string that uniquely identifies this Challenge.

status'pending' | 'expired' | 'approved' | 'denied'
urlstring uri nullable

The URL of this resource.