curl --request GET \
--url https://api.venlyfinance.com/v1/parties/{partyId}/kyc-status \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.venlyfinance.com/v1/parties/{partyId}/kyc-status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.venlyfinance.com/v1/parties/{partyId}/kyc-status', 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}/kyc-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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}/kyc-status"
req, _ := http.NewRequest("GET", 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.get("https://api.venlyfinance.com/v1/parties/{partyId}/kyc-status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.venlyfinance.com/v1/parties/{partyId}/kyc-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"result": {
"partyId": "7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22",
"verificationState": "AWAITING_CUSTOMER",
"caseStatus": "IN_REVIEW",
"requiredAction": "COMPLETE_SUMSUB_VERIFICATION",
"steps": [
{
"step": "IDENTITY",
"status": "REJECTED",
"rejectLabels": [
"DOCUMENT_EXPIRED"
],
"itemIds": []
}
],
"lastSyncedAt": "2026-07-14T09:12:44Z"
}
}{
"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": "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": {}
}Get a party's KYC status
See where a party’s KYC or KYB verification stands, and what the end customer still has to do.
curl --request GET \
--url https://api.venlyfinance.com/v1/parties/{partyId}/kyc-status \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.venlyfinance.com/v1/parties/{partyId}/kyc-status"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.venlyfinance.com/v1/parties/{partyId}/kyc-status', 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}/kyc-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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}/kyc-status"
req, _ := http.NewRequest("GET", 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.get("https://api.venlyfinance.com/v1/parties/{partyId}/kyc-status")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.venlyfinance.com/v1/parties/{partyId}/kyc-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"result": {
"partyId": "7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22",
"verificationState": "AWAITING_CUSTOMER",
"caseStatus": "IN_REVIEW",
"requiredAction": "COMPLETE_SUMSUB_VERIFICATION",
"steps": [
{
"step": "IDENTITY",
"status": "REJECTED",
"rejectLabels": [
"DOCUMENT_EXPIRED"
],
"itemIds": []
}
],
"lastSyncedAt": "2026-07-14T09:12:44Z"
}
}{
"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": "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": {}
}manage:parties — see Required scopes.
Returns where the party’s verification stands — KYC for an INDIVIDUAL, KYB for an ORGANISATION — read live from the verification platform. Use it to tell a verification that is under review apart from one that is waiting on your end customer, and to see which step needs attention.
| Field | What it tells you |
|---|---|
verificationState | The headline: AWAITING_CUSTOMER, IN_REVIEW, RESUBMISSION_REQUESTED, APPROVED or DECLINED. |
requiredAction | What the end customer still has to do — for example COMPLETE_SUMSUB_VERIFICATION. Omitted when nothing is required. |
steps | The review outcome per step, with rejectLabels explaining a rejection and itemIds listing questionnaire items that still need attention. |
caseStatus | The underlying case status, for support conversations. |
lastSyncedAt | When the state was last synchronised with the verification provider. |
verificationState is AWAITING_CUSTOMER, issue a KYC completion link and hand it to your end customer.
kycStatus/kybStatus change only once a verdict (APPROVED or DECLINED) is reached — read those from Get a party.verificationState as still in progress.
Errors
| HTTP | code | When | Retry? |
|---|---|---|---|
404 | party-not-found | No such party for your company | No |
404 | kyc-status-not-found | The party has no verification on record yet | No — start one with a verification link |
500 | identity-verification-rejected | Verification refused the request | No |
503 | identity-verification-unavailable | Platform unreachable | Yes, with backoff |
Authorizations
OAuth2 client credentials flow. Token endpoints:
- Token URL
- https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token
Headers
Which tenant the request is scoped to, among those your token grants. Omit it when the token grants exactly one tenant; it is required when the token grants more than one. A supplied value must exactly match a tenant the token grants.
Absent when required, blank, malformed, or naming a tenant the token does not grant — each gets
the same generic 403 forbidden, which reveals neither whether a tenant exists nor which ones
you may use. Send the header once: a repeated header is rejected the same way.
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Path Parameters
Unique party identifier
Response
Where the party's verification stands
Indicates whether the request was successful
Where a party's identity verification stands, relayed live from the verification platform.
Enum-like values are relayed as-is and new values may be added; treat an unknown
verificationState as still in progress.
Show child attributes
Show child attributes
Was this page helpful?

