Create a hosted verification link
curl --request POST \
--url https://api.venlyfinance.com/v1/parties/{partyId}/verification \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.venlyfinance.com/v1/parties/{partyId}/verification"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.venlyfinance.com/v1/parties/{partyId}/verification', 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.venlyfinance.com/v1/parties/{partyId}/verification",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.venlyfinance.com/v1/parties/{partyId}/verification"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.venlyfinance.com/v1/parties/{partyId}/verification")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.venlyfinance.com/v1/parties/{partyId}/verification")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"result": {
"partyId": "7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22",
"verificationUrl": "https://onboard.venly.io/kyc?token=inv-tok-9f2c41ab",
"status": "VERIFICATION_PENDING"
}
}{
"success": true,
"result": {
"partyId": "7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22",
"verificationUrl": "https://onboard.venly.io/kyc?token=inv-tok-9f2c41ab",
"status": "VERIFICATION_PENDING"
}
}{
"success": false,
"errors": [
{
"code": "unauthenticated",
"message": "Please authenticate to perform this action."
}
]
}{
"success": false,
"errors": [
{
"code": "forbidden",
"message": "You do not have permission to access this resource."
}
]
}{
"success": false,
"errors": [
{
"code": "account-not-found",
"message": "The requested resource was not found."
}
]
}{
"success": false,
"errors": [
{
"code": "party-already-verified",
"message": "Party is already VERIFIED; no verification link is needed."
}
]
}{
"success": false,
"errors": [
{
"code": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}{
"success": false,
"errors": [
{
"code": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}Parties
Create a verification link
Mint a hosted KYC or KYB link to send an end-user through verification.
POST
/
parties
/
{partyId}
/
verification
Create a hosted verification link
curl --request POST \
--url https://api.venlyfinance.com/v1/parties/{partyId}/verification \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.venlyfinance.com/v1/parties/{partyId}/verification"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.venlyfinance.com/v1/parties/{partyId}/verification', 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.venlyfinance.com/v1/parties/{partyId}/verification",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.venlyfinance.com/v1/parties/{partyId}/verification"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.venlyfinance.com/v1/parties/{partyId}/verification")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.venlyfinance.com/v1/parties/{partyId}/verification")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"result": {
"partyId": "7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22",
"verificationUrl": "https://onboard.venly.io/kyc?token=inv-tok-9f2c41ab",
"status": "VERIFICATION_PENDING"
}
}{
"success": true,
"result": {
"partyId": "7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22",
"verificationUrl": "https://onboard.venly.io/kyc?token=inv-tok-9f2c41ab",
"status": "VERIFICATION_PENDING"
}
}{
"success": false,
"errors": [
{
"code": "unauthenticated",
"message": "Please authenticate to perform this action."
}
]
}{
"success": false,
"errors": [
{
"code": "forbidden",
"message": "You do not have permission to access this resource."
}
]
}{
"success": false,
"errors": [
{
"code": "account-not-found",
"message": "The requested resource was not found."
}
]
}{
"success": false,
"errors": [
{
"code": "party-already-verified",
"message": "Party is already VERIFIED; no verification link is needed."
}
]
}{
"success": false,
"errors": [
{
"code": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}{
"success": false,
"errors": [
{
"code": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}Requires scope:
See Hosted verification links for the full flow, or Sumsub token sharing for the alternative route.
manage:parties — see Required scopes.
Mints a hosted verification link and returns the URL matching the party’s type — the KYC flow for INDIVIDUAL, the KYB flow for ORGANISATION. There is no request body: the stored partyType decides the flow.
Hand the URL to the end-user. The verdict arrives asynchronously and flips the party’s kycStatus/kybStatus — poll Get a party for the outcome.
Links do not expire. Re-POSTing while a link is live returns the same URL with
200; if it was revoked, a fresh one comes back with 201. Either way you can safely call this again — you will not strand the user with a dead link.Treat
verificationUrl as a credential. It grants access to the end-user’s onboarding session, so deliver it over a channel you trust and never log it.Errors
The codes this endpoint can return, in addition to the standard errors. Branch oncode, never the message.
| HTTP | code | When |
|---|---|---|
409 | verification-not-provisioned | the company has no provisioned verification tenant |
409 | party-already-verified | the party’s kycStatus/kybStatus is already VERIFIED |
Authorizations
OAuth2 client credentials flow. Token endpoints:
Path Parameters
Unique party identifier
Response
The party's existing live verification link was reissued unchanged
Indicates whether the request was successful
A hosted verification link minted for a party. Only the URL matching the party's type is
exposed — the KYC flow for INDIVIDUAL, the KYB flow for ORGANISATION. The link does not
expire; it stays valid until revoked, and a re-POST reissues the
same URL.
Show child attributes
Show child attributes
Was this page helpful?

