Skip to main content
POST
Create session

Authorizations

Authorization
string
header
required

OAuth 2.0

Scopes

widgets.kyc.sessions:create

Grants access to create KYC widget sessions.

Body

application/json
flow
enum<string>
required

The flow of the KYC widget session.

Available options:
verify
processes
enum<string>[]

The KYC processes to include in the session. Defaults to all widget-supported processes with the 'uphold-verified' model.

Minimum array length: 1
Available options:
profile,
identity,
proof-of-address,
customer-due-diligence,
tax-details
options
object

Additional options for the widget session.

Response

Session created.

session
object
required