> ## 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 partner-terms consent state

> Whether the end customer still has to accept our partners' terms — and the link to hand them.

**Requires scope:** `manage:parties` — see [Required scopes](/getting-started/authentication#required-scopes-finance-api).

Returns one `status` and, while acceptance is outstanding, one `consentUrl` — covering **every** partner the party is onboarding to. You never deal with partners individually.

| `status`       | Meaning                                                                                              | What you do            |
| -------------- | ---------------------------------------------------------------------------------------------------- | ---------------------- |
| `NOT_REQUIRED` | Nothing outstanding — including a party that hasn't passed KYC yet                                   | Nothing                |
| `REQUIRED`     | The end customer must accept before onboarding proceeds                                              | Hand them `consentUrl` |
| `ACCEPTED`     | Every enabled partner's currently-active terms are accepted, so onboarding is not blocked on consent | Nothing                |

<Note>
  `REQUIRED` always comes with a `consentUrl`. That pairing is guaranteed — if the platform reports terms outstanding without a link, you get a retryable `503` instead of a `REQUIRED` you can't act on.
</Note>

Each call returns the current state and link, so an expiring or re-issued link is never stale. If you'd rather poll the plain party read, `partnerTermsStatus` on [Get party details](/api-reference/Finance-API/parties/get-party-details) carries the same value.

<Warning>
  **`ACCEPTED` is not the end.** It is evaluated against the terms active *now*, so enabling a new partner — or a partner publishing a new terms version — supersedes what was accepted and moves the party back to `REQUIRED`. Re-read it; don't record it as a done milestone.
</Warning>

## Errors

| HTTP  | `code`                              | When                                                                           | Retry?                |
| ----- | ----------------------------------- | ------------------------------------------------------------------------------ | --------------------- |
| `500` | `identity-verification-rejected`    | Verification refused the request itself                                        | **No**                |
| `503` | `identity-verification-unavailable` | Platform unreachable, or it answered but the state couldn't be resolved safely | **Yes**, with backoff |

A `503` here **never** means "nothing outstanding". The endpoint fails closed rather than guessing, so treating it as `NOT_REQUIRED` would skip the gate.

See [Partner-terms consent](/guides/finance/onboarding/partner-terms-consent).


## OpenAPI

````yaml api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/partner-terms
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:
    get:
      tags:
        - Parties
      summary: Get a party's partner-terms consent state
      description: >
        **Requires scope:** `manage:parties`


        Returns whether this party's end customer still has to accept our
        partners' terms, and while they do,

        the link to hand them.


        Party-level and partner-agnostic: one `status` and one `consentUrl`
        covering **every** partner the party

        is onboarding to, however many that is. You never deal with partners
        individually.


        Each call returns the **current** state and link, so an expiring or
        re-issued link is never stale. If you

        prefer polling the plain party read instead, `partnerTermsStatus` on

        [Get party
        details](/api-reference/Finance-API/parties/get-party-details) carries
        the same state.


        Consent is the **final gate after KYC**: a party that is not yet
        KYC-verified answers `NOT_REQUIRED`

        with no URL, because there is nothing to accept yet.


        See [Partner-terms
        consent](/guides/finance/onboarding/partner-terms-consent).
      operationId: getPartyPartnerTerms
      parameters:
        - $ref: '#/components/parameters/PartyId'
      responses:
        '200':
          description: The party's consent state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SinglePartyPartnerTermsResponse'
              example:
                success: true
                result:
                  partyId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  status: REQUIRED
                  consentUrl: https://onboard.venly.io/partner-terms?token=cons-tok-9f3a2b
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          description: >
            `identity-verification-rejected` — verification refused the request
            itself. **Not

            retryable**; the request will keep failing until the underlying
            cause is resolved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: >
            `identity-verification-unavailable` — **retryable**. Either
            verification could not be

            reached, or it answered but the state could not be resolved safely:
            data was missing, or it reported

            terms outstanding without a link.


            This endpoint deliberately fails closed rather than guessing. A
            `503` never means "nothing

            outstanding" — 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:
    SinglePartyPartnerTermsResponse:
      allOf:
        - $ref: '#/components/schemas/BaseResponse'
        - type: object
          properties:
            result:
              $ref: '#/components/schemas/PartyPartnerTerms'
    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
    PartyPartnerTerms:
      type: object
      description: A party's partner-terms consent state, current as of the call.
      required:
        - partyId
        - status
      properties:
        partyId:
          type: string
          format: uuid
        status:
          $ref: '#/components/schemas/PartnerTermsStatus'
        consentUrl:
          type: string
          nullable: true
          description: >
            The hosted page to hand to the end customer. Present **only** while
            `status` is `REQUIRED` — that

            pairing is guaranteed, so a `REQUIRED` without a URL is reported as
            a retryable `503` rather than

            returned to you.


            Treat it as a credential: it embeds a scoped, expiring token and is
            specific to this party.
          example: https://onboard.venly.io/partner-terms?token=cons-tok-9f3a2b
    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.
    PartnerTermsStatus:
      type: string
      description: >
        Whether a party's end customer still has to accept our partners' terms.
        Party-level and

        partner-agnostic — one value regardless of how many partners are
        involved.


        - `NOT_REQUIRED` — nothing outstanding. Also the answer for a party that
        has not passed KYC yet, since
          there is nothing to accept before then.
        - `REQUIRED` — the end customer must accept before onboarding can
        proceed. A `consentUrl` is always
          present alongside this value.
        - `ACCEPTED` — every enabled partner's **currently-active** terms have
        been accepted, so onboarding
          is not blocked on consent.

        <Note>

        `ACCEPTED` is **not** terminal, because it is evaluated against the
        terms that are active *now*.

        Enabling a new partner, or a partner publishing a new terms version,
        supersedes what was accepted and

        moves the party back to `REQUIRED`. Re-read it rather than caching it as
        a completed milestone.

        </Note>
      enum:
        - NOT_REQUIRED
        - REQUIRED
        - ACCEPTED
  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: {}

````