API Reference

Krystal Identity API

Resources & Endpoints

Create user identity check intent

Creates an identity check intent for a user.

POST
https://identity.krystal.io/api/v1/user/identity_check

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

properties Required

User identity check properties None

Returned Object

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

{
    identity_check: UserIdentityCheckIntent {
        id: String
        url: String
        state: IdentityCheckStateEnum
        expires_at: Unix Timestamp
    }
}