> ## 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.
# Issue a partner-terms consent link
> Mint a consent link so your customer can accept every partner's terms before onboarding starts.
**Requires scope:** `manage:parties` — see [Required scopes](/getting-started/authentication#required-scopes-finance-api).
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](/api-reference/Finance-API/parties/get-a-partys-partner-terms-consent-state) for that.
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.
## 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 |
See [Partner-terms consent](/guides/finance/onboarding/partner-terms-consent).
## OpenAPI
````yaml api-reference/Finance-API-Specs.yaml POST /parties/{partyId}/partner-terms/link
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.
version: 1.5.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: Fiat-to-crypto payment session creation
- 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 and delivery testing
paths:
/parties/{partyId}/partner-terms/link:
post:
tags:
- Parties
summary: Issue a partner-terms consent link up front
description: >
**Requires scope:** `manage:parties`
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 would 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.
Each call mints a new link and **supersedes any previous live link** for
that party. Don't call it to
"check" the state — a link you handed out earlier stops working. Read
[the consent
state](/api-reference/Finance-API/parties/get-a-partys-partner-terms-consent-state)
for that.
The URL embeds a scoped, expiring token: treat it as a credential, not a
public page. Once the customer
accepts, the party's consent state reflects it.
operationId: createPartyPartnerTermsLink
parameters:
- $ref: '#/components/parameters/PartyId'
responses:
'201':
description: A consent link was issued
content:
application/json:
schema:
$ref: '#/components/schemas/SinglePartyPartnerTermsLinkResponse'
example:
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'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'409':
description: >
`verification-not-provisioned` — verification is not enabled for
your company, so no link can be
issued. Ask Venly to enable it; retrying will not help.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: >
`identity-verification-rejected` — verification refused the request.
**Not retryable.**
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'503':
description: >
`identity-verification-unavailable` — **retryable**. Verification
could not be reached
or could not produce a link. Retry with backoff.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
parameters:
PartyId:
name: partyId
in: path
required: true
description: Unique party identifier
schema:
type: string
format: uuid
example: 7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22
schemas:
SinglePartyPartnerTermsLinkResponse:
allOf:
- $ref: '#/components/schemas/BaseResponse'
- type: object
properties:
result:
$ref: '#/components/schemas/PartyPartnerTermsLink'
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
PartyPartnerTermsLink:
type: object
description: >
A freshly issued consent link, letting the end customer accept every
enabled partner's latest terms up
front — before any of their data reaches a partner.
required:
- partyId
- consentUrl
properties:
partyId:
type: string
format: uuid
consentUrl:
type: string
description: >-
The hosted page to hand to the end customer. Treat it as a
credential.
example: https://onboard.venly.io/partner-terms?token=cons-tok-4c81de
expiresAt:
type: string
format: date-time
nullable: true
description: >-
When this link stops working. Issue a new one rather than trying to
extend it.
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.
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.
Forbidden:
description: Caller lacks the required authority/role (403)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
success: false
errors:
- code: forbidden
message: You do not have permission to access this resource.
NotFound:
description: Resource not found (404)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
success: false
errors:
- code: account-not-found
message: The requested resource was not found.
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: {}
````