Get your company profile
curl --request GET \
--url https://api.venlyfinance.com/v1/company \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.venlyfinance.com/v1/company"
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/company', 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/company",
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/company"
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/company")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.venlyfinance.com/v1/company")
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": {
"id": "0c5a7e2d-9b14-4f63-a8d1-3e6f2b9c4a70",
"name": "Acme Payments Ltd",
"kybStatus": "VERIFIED",
"status": "ACTIVE",
"walletType": "SELF_CUSTODY",
"supportedChains": [
"BASE",
"AVALANCHE"
],
"billingUrl": "https://billing.example.com/customers/0c5a7e2d",
"createdAt": "2026-06-02T08:15:00Z"
}
}{
"success": false,
"errors": [
{
"code": "unauthenticated",
"message": "Please authenticate to perform this action."
}
]
}{
"success": false,
"errors": [
{
"code": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}Company
Get your company profile
Read your own company’s KYB and lifecycle status, wallet type, supported chains and billing portal link.
GET
/
company
Get your company profile
curl --request GET \
--url https://api.venlyfinance.com/v1/company \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.venlyfinance.com/v1/company"
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/company', 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/company",
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/company"
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/company")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.venlyfinance.com/v1/company")
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": {
"id": "0c5a7e2d-9b14-4f63-a8d1-3e6f2b9c4a70",
"name": "Acme Payments Ltd",
"kybStatus": "VERIFIED",
"status": "ACTIVE",
"walletType": "SELF_CUSTODY",
"supportedChains": [
"BASE",
"AVALANCHE"
],
"billingUrl": "https://billing.example.com/customers/0c5a7e2d",
"createdAt": "2026-06-02T08:15:00Z"
}
}{
"success": false,
"errors": [
{
"code": "unauthenticated",
"message": "Please authenticate to perform this action."
}
]
}{
"success": false,
"errors": [
{
"code": "invalid-request",
"message": "The request contains invalid parameters."
}
],
"result": {}
}Requires scope: any of
The billing portal is per company, not per invoice. Opening it asks for your email address and sends a sign-in link; only contacts on your billing account can get in. See Billing.
manage:accounts, manage:transfers or manage:pay-in-sessions — see Required scopes.
Returns the profile of the company your token belongs to. There’s no path parameter: the company is resolved from the token, so no request can name another company. It’s a good first call to confirm your credentials work.
| Field | What it tells you |
|---|---|
kybStatus | Your company’s own verification: PENDING, VERIFIED or DENIED. |
status | ONBOARDING until Venly activates you, then ACTIVE. SUSPENDED is reversible; ABORTED is not. |
walletType | VENLY_MANAGED or SELF_CUSTODY — see Managed vs. self-custody. |
supportedChains | The chains your company is configured for. For the assets on them, use List supported assets. |
billingUrl | Your billing portal. Absent until Venly links your company to a billing account — treat a missing field as “billing not set up yet”, not as an error. |
A token without a qualifying scope, without a company, or for a company not yet active on Finance gets
403. There is no 404 to branch on.Authorizations
OAuth2 client credentials flow. Token endpoints:
FlowClient Credentials
- 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.
Example:
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Was this page helpful?

