Skip to main content
POST
/
widgets
/
kyc
/
sessions
Create session
curl --request POST \
  --url https://api.enterprise.sandbox.uphold.com/widgets/kyc/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "flow": "verify",
  "processes": [
    "identity",
    "proof-of-address"
  ]
}
'
{
  "session": {
    "flow": "verify",
    "data": {
      "processes": [
        "identity",
        "proof-of-address"
      ]
    },
    "token": "GEbRxBN...edjnXbL",
    "url": "https://kyc.enterprise.uphold.com/"
  }
}

Authorizations

​
Authorization
string
header
required

OAuth 2.0

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:
identity,
proof-of-address

Response

Session created.

​
session
object
required