Skip to main content
id
string
required

Unique identifier for the object.

created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

object
enum<string>
required
Available options:
verification_session
completed_at
integer | null
required

The time at which the verification session was completed.

credit_check
object
required

Credit check details, when the session includes a credit check.

identity
object
required

Identity verification details, when the session includes identity verification.

income
object
required

Income verification details, when the session includes income verification.

monitor
object
required

Monitor verification details, when the session includes monitor verification.

options
object
required

Options applied to the verification session.

provided_details
object
required

Details provided by the individual at the start of the verification session.

requirements
object
required

Requirements for completing the verification session.

return_url
string | null
required

The URL the user will be redirected to after completing verification.

right_to_rent
object
required

Right-to-rent verification details, when the session includes a right-to-rent check.

status
enum<string>
required

The status of the verification session.

Available options:
pending,
complete,
canceled
types
enum<string>[]
required

The verifications included in this session.

Available options:
identity,
right_to_rent,
income,
credit_check,
monitor
url
string | null
required

The hosted URL the user can visit to complete verification.

verified_outputs
object
required

Verified outputs available once verification is complete.

verification_report
required

The verification report produced for this session, when available.

account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted
boolean
default:false

Only returned if the object has been deleted.

manually_reviewed
boolean
default:false

Whether the verification session was manually reviewed.