API Reference

Krystal Identity API

Resources & Endpoints

Use a user verification intent

Returns details of a user verification intent and marks it as used.

POST
https://identity.krystal.io/api/v1/user/verifications/{verification}/use

If successful, this endpoint will return a 200 OK status.

Scopes

One of the following scopes are required to use this endpoint.

Arguments

The following arguments are supported for this endpoint.

Name Type Default Value

verification Required

User verification intent Lookup None

Potential Errors

The following errors may occur during this request.

Details HTTP status

verification_not_found

No user verification intent was found matching any of the criteria provided in the arguments

 404 Not Found

Returned Object

When the request is successful, you can expect an object matching the specification below to be returned.

{
    verification: UserVerificationIntent {
        id: String
        return_url: String
        verified: Boolean
        verified_at: Unix Timestamp?
    }
}