Skip to main content
GET
Get hosted KYC session

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

sessionId
string
required

Response

Session details

sessionId
string
required
verificationUrl
string<uri>
required
workspaceId
string
required
userId
string
required
status
enum<string>
required
Available options:
not_started,
processing,
completed,
failed
createdAt
string<date-time>
required
kycStatus
enum<string> | null
Available options:
Approved,
Submitted,
Declined,
null
updatedAt
string<date-time>
redirectUrl
string<uri> | null
metadata
object | null
applicantFirstName
string | null
applicantLastName
string | null
applicant
string | null

Full applicant name

detectedDocumentType
string | null
expectedDocumentType
string | null
retryAttempt
integer

Number of retry attempts

document
object | null

Extracted document details and scores

face
object | null

Face match details

overall
object | null

Overall verification result

images
object | null
verification
object | null