> ## Documentation Index > Fetch the complete documentation index at: https://docs.venlyfinance.com/llms.txt > Use this file to discover all available pages before exploring further. # Get your company profile > Read your own company's KYB and lifecycle status, wallet type, supported chains and billing portal link. **Requires scope:** any of `manage:accounts`, `manage:transfers` or `manage:pay-in-sessions` — see [Required scopes](/getting-started/authentication#required-scopes-finance-api). 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](/guides/finance/managed-vs-self-custody). | | `supportedChains` | The chains your company is configured for. For the assets on them, use [List supported assets](/api-reference/Finance-API/supported-assets/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. | 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](/guides/finance/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. ## OpenAPI ````yaml api-reference/Finance-API-Specs.yaml GET /company openapi: 3.1.0 info: title: Venly Finance API description: > REST API for the Venly Finance platform: - Party management (Individuals & Organisations) - Identity verification — hosted KYC/KYB links and Sumsub share-token forwarding - Account management with party association - Wallet balances & token allowances on supported chains - Virtual bank accounts for global pay-in (EUR SEPA, USD ACH/WIRE/RTP/SWIFT) - Fiat-to-crypto payment sessions (pay-in) - Bank pay-outs — beneficiary allow-listing, routes, and PULL/PUSH pay-outs - Account-to-account fiat & crypto transfers - EIP-2612 permits and allowances - Webhook registration for asynchronous event delivery ## Authentication All endpoints use OAuth2 client credentials. Obtain a token first, then include it in every request: **Step 1 — Get a token:** ```bash curl -X POST https://login.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "grant_type=client_credentials&client_id={CLIENT_ID}&client_secret={CLIENT_SECRET}" ``` **Step 2 — Use the token:** ``` Authorization: Bearer {access_token} ``` Tokens expire after **5 minutes**. Implement refresh logic in your client. ## Selecting a tenant A token that grants more than one tenant must say which one each request is for, in the `x-tenant-id` header. With a single-tenant token, omit it. Any value you send must exactly match a tenant the token grants; a missing, malformed or foreign value is answered with a generic `403 forbidden` that reveals nothing about which tenants exist. Send the header at most once. ## Request correlation Every response — including `401` and `403` — carries an `X-Correlation-Id` header identifying the operation in our logs. Quote it in a support request. You may supply your own, as `X-Correlation-Id` or (as a fallback) `X-Request-Id`, matching `^[A-Za-z0-9_.:-]{1,64}$`. A value outside that shape is replaced with a generated one rather than rejected. version: 1.10.0 contact: name: Venly Support email: support@venly.io url: https://docs.venlyfinance.com license: name: Proprietary x-logo: url: https://venlyfinance.com/logo.png x-security-contact: security@venly.io servers: - url: https://api.venlyfinance.com/v1 description: Production - url: https://api-staging.venlyfinance.com/v1 description: Staging security: - OAuth2: [] tags: - name: Parties description: Party management (Individuals & Organisations) - name: Accounts description: Account management, party-role associations - name: Wallets description: Blockchain wallet balances - name: Virtual Bank Accounts description: Virtual bank account payment references for global payments - name: Fiat-to-crypto Payment Sessions description: >- Hosted fiat-to-crypto pay-in sessions. **Coming soon** — not yet enabled; use a virtual bank account to receive fiat today. - name: Payout Bank Accounts description: Allow-listing beneficiary bank accounts as pay-out destinations - name: Payout Routes description: >- Account-scoped routes pairing a beneficiary bank account with a crypto deposit asset - name: Payouts description: Crypto-to-fiat pay-outs over a registered route - name: Transfers description: Fiat and crypto transfer operations between accounts - name: Permits description: EIP-712 permit signature management for token approvals - name: Supported Assets description: >- Discover which chains and assets your tenant can settle in, and whether an account can use them yet. - name: Allowances description: Token allowance management for wallets - name: Webhooks description: Webhook registration, delivery testing and delivery history - name: Pay-Ins description: >- The pay-in ledger — every fiat credit that settled (or failed to settle) into an account wallet - name: Billing description: The invoices Venly has issued to your company - name: API Credentials description: Self-service management of your company's OAuth client credentials - name: Company description: Your own company profile paths: /company: parameters: - $ref: '#/components/parameters/TenantId' get: tags: - Company summary: Get your company profile description: > **Requires scope:** any of `manage:accounts`, `manage:transfers` or `manage:pay-in-sessions` Returns the profile of the company your token belongs to. There is no path parameter and no request body: the company is resolved from the token, so no request can name another company. A deliberately narrow view: it carries your KYB and lifecycle status, wallet type and supported chains. Supported assets are served by [List supported assets](/api-reference/Finance-API/supported-assets/list-supported-assets). `billingUrl` appears once Venly has linked your company to a billing account. It opens your billing portal, the place to read the invoices Venly has issued to you. operationId: getOwnCompany responses: '200': description: Your company's profile content: application/json: schema: $ref: '#/components/schemas/CompanyProfileResponse' example: 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' '401': $ref: '#/components/responses/Unauthorized' '403': description: > Forbidden — the token lacks a qualifying scope, or carries no company, or its company is not yet active on Finance. There is no `404` to branch on. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: parameters: TenantId: name: x-tenant-id in: header required: false description: > 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. schema: type: string format: uuid example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 schemas: CompanyProfileResponse: allOf: - $ref: '#/components/schemas/BaseResponse' - type: object properties: result: $ref: '#/components/schemas/CompanyProfile' ErrorResponse: type: object description: Error response wrapper properties: success: type: boolean description: Always false for error responses example: false errors: type: array description: List of errors that occurred items: $ref: '#/components/schemas/ErrorBody' result: type: object nullable: true description: Null or omitted when success is false BaseResponse: type: object properties: success: type: boolean description: Indicates whether the request was successful CompanyProfile: type: object description: >- Your own company profile — a deliberately narrow view of your company record. required: - id - name - kybStatus - status - walletType - supportedChains - createdAt properties: id: type: string format: uuid description: Your company id name: type: string description: Company name kybStatus: type: string description: Know-Your-Business verification state of your company enum: - PENDING - VERIFIED - DENIED status: type: string description: > Lifecycle of your company. `ONBOARDING` until Venly activates you (which requires `kybStatus: VERIFIED`), then `ACTIVE`. `SUSPENDED` is reversible; `ABORTED` is not. enum: - ONBOARDING - ACTIVE - SUSPENDED - ABORTED walletType: $ref: '#/components/schemas/WalletType' supportedChains: type: array description: Chains your company is configured for items: type: string example: - BASE - AVALANCHE billingUrl: type: string format: uri description: > Your billing portal, where you read the invoices Venly has issued to you. **Absent** until Venly links your company to a billing account — treat a missing field as "billing not set up yet", not as an error. The portal is per company, not per invoice, and asks for your email address before sending a sign-in link; only contacts on your billing account can get in. createdAt: type: string format: date-time description: When your company was onboarded to Finance ErrorBody: type: object description: Individual error details properties: code: type: string description: Machine-readable error code example: invalid-request message: type: string description: Human-readable error message example: The request contains invalid parameters. WalletType: type: string description: Custody model of the wallet enum: - VENLY_MANAGED - SELF_CUSTODY responses: Unauthorized: description: Authentication required or failed (401) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false errors: - code: unauthenticated message: Please authenticate to perform this action. securitySchemes: OAuth2: type: oauth2 description: > OAuth2 client credentials flow. Token endpoints: - Staging: https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token - Production: https://login.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token flows: clientCredentials: tokenUrl: >- https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/token scopes: {} ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.