Skip to main content
GET
Get your company profile
Requires scope: any of 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. 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.
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

FlowClient Credentials
Token URL
https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token

Headers

x-tenant-id
string<uuid>

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"

Response

Your company's profile

success
boolean

Indicates whether the request was successful

result
object

Your own company profile — a deliberately narrow view of your company record.