Skip to main content
GET
CLI

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

200 - application/json

Session configuration with document requirements

id
string
required
organizationId
string
required
organization
object
required
customerId
string | null
required
verificationSubtype
string
required
countryCode
string
required
email
string
required
name
string
required
status
string
required
expiresAt
string
required
completedAt
string | null
required
submittedAt
string | null
required
completedSteps
string[]
required
requiredSteps
string[]
required
requiredFields
object[]
required
requiredDocuments
object[]
required
documentRequirements
object
required
steps
object[]
required
estimatedCompletionTimeMinutes
number | null
required
collectedData
object
required
providerData
object | null
required
providerSessionId
string | null
required
verificationUrl
string | null
required
metadata
object
required
fillOnBehalf
boolean
required
createdAt
string
required
updatedAt
string
required
featureFlags
string[]
required

Feature flags enabled for the organization

Example:
bankPartnerAgreementsRequired
boolean
required

Whether additional banking agreements must be accepted

associatedEntityId
string

Associated entity ID. Present when this is a UBO KYC session.

Example:

"asp_abc123"

customerName
string

Customer/business name. Present when this is a UBO KYC session.

Example:

"Acme Corporation"

enhancedDiligence
object
deviceRiskSessionKey
string | null

Server-generated session key for device-intelligence collection on the hosted verification UI. Absent when the integration is not configured.