Issue a partner-terms consent link up front
curl --request POST \
--url https://api.venlyfinance.com/v1/parties/{partyId}/partner-terms/link \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.venlyfinance.com/v1/parties/{partyId}/partner-terms/link"
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}/partner-terms/link', 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}/partner-terms/link",
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}/partner-terms/link"
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}/partner-terms/link")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.venlyfinance.com/v1/parties/{partyId}/partner-terms/link")
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": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"consentUrl": "https://onboard.venly.io/partner-terms?token=cons-tok-4c81de",
"expiresAt": "2026-08-31T09:14:52Z"
}
}{
"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": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}{
"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
Issue a partner-terms consent link
Mint a consent link so your customer can accept every partner’s terms before onboarding starts.
POST
/
parties
/
{partyId}
/
partner-terms
/
link
Issue a partner-terms consent link up front
curl --request POST \
--url https://api.venlyfinance.com/v1/parties/{partyId}/partner-terms/link \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.venlyfinance.com/v1/parties/{partyId}/partner-terms/link"
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}/partner-terms/link', 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}/partner-terms/link",
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}/partner-terms/link"
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}/partner-terms/link")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.venlyfinance.com/v1/parties/{partyId}/partner-terms/link")
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": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"consentUrl": "https://onboard.venly.io/partner-terms?token=cons-tok-4c81de",
"expiresAt": "2026-08-31T09:14:52Z"
}
}{
"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": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}{
"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:
The URL embeds a scoped, expiring token. Treat it as a credential: don’t log it, don’t put it in a shared inbox, and don’t reuse it across customers. When it expires, issue a new one rather than trying to extend it.
See Partner-terms consent.
manage:parties — see Required scopes.
Mints a fresh consent link so your end customer can accept every partner’s terms before onboarding begins — before any of their data is sent to a partner.
Use this when you’d rather collect consent up front than wait for it to become a blocker. The hosted page shows every currently-enabled partner’s latest terms in one pass, whether or not the party has been forwarded to any partner yet.
Takes no request body.
Every call supersedes the previous link. A link you already handed out stops working the moment you call this again. Don’t use it to check state — read the consent state for that.
Errors
| HTTP | code | When | Retry? |
|---|---|---|---|
409 | verification-not-provisioned | Verification isn’t enabled for your company | No — ask Venly to enable it |
500 | identity-verification-rejected | Verification refused the request | No |
503 | identity-verification-unavailable | Platform unreachable or couldn’t produce a link | Yes, with backoff |
Authorizations
OAuth2 client credentials flow. Token endpoints:
Path Parameters
Unique party identifier
Was this page helpful?

