KYC sharing

Create session

Create a new session for KYC sharing.

post/topper/kyc-sharing/sessions

Request

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

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.

userIdstring uuid required

The user ID to create the KYC sharing session for.

KYC sharing already completed.

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