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"
],
"options": {
"theme": {
"appearance": "dark"
}
}
}
'import requests
url = "https://api.enterprise.sandbox.uphold.com/widgets/kyc/sessions"
payload = {
"flow": "verify",
"processes": ["identity", "proof-of-address"],
"options": { "theme": { "appearance": "dark" } }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
flow: 'verify',
processes: ['identity', 'proof-of-address'],
options: {theme: {appearance: 'dark'}}
})
};
fetch('https://api.enterprise.sandbox.uphold.com/widgets/kyc/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.enterprise.sandbox.uphold.com/widgets/kyc/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'flow' => 'verify',
'processes' => [
'identity',
'proof-of-address'
],
'options' => [
'theme' => [
'appearance' => 'dark'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.enterprise.sandbox.uphold.com/widgets/kyc/sessions"
payload := strings.NewReader("{\n \"flow\": \"verify\",\n \"processes\": [\n \"identity\",\n \"proof-of-address\"\n ],\n \"options\": {\n \"theme\": {\n \"appearance\": \"dark\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.enterprise.sandbox.uphold.com/widgets/kyc/sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"flow\": \"verify\",\n \"processes\": [\n \"identity\",\n \"proof-of-address\"\n ],\n \"options\": {\n \"theme\": {\n \"appearance\": \"dark\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enterprise.sandbox.uphold.com/widgets/kyc/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"flow\": \"verify\",\n \"processes\": [\n \"identity\",\n \"proof-of-address\"\n ],\n \"options\": {\n \"theme\": {\n \"appearance\": \"dark\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"session": {
"flow": "verify",
"data": {
"processes": [
"identity",
"proof-of-address"
]
},
"token": "GEbRxBN...edjnXbL",
"url": "https://kyc.enterprise.uphold.com/?sessionToken=NDcyZjA5ZmQtODkzOC00NTUwLTlkMjYtNGQwZWI5NDRkYTQy"
}
}KYC
Create session
Create a new session for the KYC Widget.
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"
],
"options": {
"theme": {
"appearance": "dark"
}
}
}
'import requests
url = "https://api.enterprise.sandbox.uphold.com/widgets/kyc/sessions"
payload = {
"flow": "verify",
"processes": ["identity", "proof-of-address"],
"options": { "theme": { "appearance": "dark" } }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
flow: 'verify',
processes: ['identity', 'proof-of-address'],
options: {theme: {appearance: 'dark'}}
})
};
fetch('https://api.enterprise.sandbox.uphold.com/widgets/kyc/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.enterprise.sandbox.uphold.com/widgets/kyc/sessions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'flow' => 'verify',
'processes' => [
'identity',
'proof-of-address'
],
'options' => [
'theme' => [
'appearance' => 'dark'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.enterprise.sandbox.uphold.com/widgets/kyc/sessions"
payload := strings.NewReader("{\n \"flow\": \"verify\",\n \"processes\": [\n \"identity\",\n \"proof-of-address\"\n ],\n \"options\": {\n \"theme\": {\n \"appearance\": \"dark\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.enterprise.sandbox.uphold.com/widgets/kyc/sessions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"flow\": \"verify\",\n \"processes\": [\n \"identity\",\n \"proof-of-address\"\n ],\n \"options\": {\n \"theme\": {\n \"appearance\": \"dark\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enterprise.sandbox.uphold.com/widgets/kyc/sessions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"flow\": \"verify\",\n \"processes\": [\n \"identity\",\n \"proof-of-address\"\n ],\n \"options\": {\n \"theme\": {\n \"appearance\": \"dark\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"session": {
"flow": "verify",
"data": {
"processes": [
"identity",
"proof-of-address"
]
},
"token": "GEbRxBN...edjnXbL",
"url": "https://kyc.enterprise.uphold.com/?sessionToken=NDcyZjA5ZmQtODkzOC00NTUwLTlkMjYtNGQwZWI5NDRkYTQy"
}
}Authorizations
OAuth 2.0
FlowClient Credentials
- Token URL
- /core/oauth2/token
Scopes1
widgets.kyc.sessions:create
Grants access to create KYC widget sessions.
Body
application/json
The flow of the KYC widget session.
Available options:
verify The KYC processes to include in the session. Defaults to all widget-supported processes with the 'uphold-verified' model.
Minimum array length:
1Available options:
profile, identity, proof-of-address, customer-due-diligence Additional options for the widget session.
Response
Session created.
Show child attributes
Show child attributes
Was this page helpful?