KYC

Create session

Create a new session for the KYC Widget.

post/widgets/kyc/sessions

Request

Base URL
https://api.enterprise.sandbox.uphold.com
Auth
OAuth 2
Client credentials
Token URL/core/oauth2/token
Scopeswidgets.kyc.sessions:create
TypeScript
https://skmtc.dev/uphold/apis/widget-api/docs/widgets/kyc/sessions/post.ts
A function with typed inputs. Its response is checked against the schema.

X-On-Behalf-Ofstring

The subject on whose behalf the operation is being performed.

string ipv4

string ipv6

Contains the IP of the end user that is requesting the operation.

X-Uphold-User-Agentstring

Contains the user agent of the end user that is requesting the operation.

X-Uphold-User-Originstring

Contains the origin of the request made by the end user.

X-Uphold-User-Countrystring

Contains the code of the country of the end user that is requesting the operation.

X-Uphold-User-Subdivisionstring

Contains the code of the subdivision of the end user that is requesting the operation.

X-Uphold-User-Citystring

Contains the name of the city of the end user that is requesting the operation.

flow'verify' required

The flow of the KYC widget session.

processesstring[]

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

optionsobject

Additional options for the widget session.

Session created.

No recorded changes to this operation across all 1 revision of this API.