> ## 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 a party's partner-onboarding status > Read where a party stands with our banking partner's recipient checks, without attempting provisioning. **Requires scope:** `manage:parties` — see [Required scopes](/getting-started/authentication#required-scopes-finance-api). Returns whether the party has been relayed to our banking partner and where the partner's own recipient checks stand — the third readable onboarding gate next to [identity verification](/api-reference/Finance-API/parties/get-verification-linkage) and [partner-terms consent](/api-reference/Finance-API/parties/get-a-partys-partner-terms-consent-state). Read it before provisioning: `PENDING` here is exactly what [creating a virtual bank account](/api-reference/Finance-API/virtual-bank-accounts/create-a-virtual-bank-account) would refuse with `409 partner-onboarding-pending`. `NOT_STARTED` is a normal `200`. See [Partner onboarding](/guides/finance/onboarding/partner-onboarding). ## OpenAPI ````yaml api-reference/Finance-API-Specs.yaml GET /parties/{partyId}/partner-onboarding 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: /parties/{partyId}/partner-onboarding: parameters: - $ref: '#/components/parameters/TenantId' get: tags: - Parties summary: Get a party's partner-onboarding status description: > **Requires scope:** `manage:parties` Returns whether the party has been relayed to our banking partner and where the partner's own recipient checks stand — the readable peer of `/iv-verification` and `/partner-terms`. Use it to see "onboarding at the partner is still in progress" up front and wait, instead of discovering it only when [creating a virtual bank account](/api-reference/Finance-API/virtual-bank-accounts/create-a-virtual-bank-account) or a payout route fails with `partner-onboarding-pending`. Read-only: it never triggers a provisioning attempt. `NOT_STARTED` (no partner record yet) is a `200`, not an error. The value advances on its own as reconciliation with the partner progresses. operationId: getPartyPartnerOnboarding parameters: - $ref: '#/components/parameters/PartyId' responses: '200': description: The party's partner-onboarding status content: application/json: schema: $ref: '#/components/schemas/SinglePartyPartnerOnboardingResponse' example: success: true result: partyId: 7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22 status: PENDING '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' 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 PartyId: name: partyId in: path required: true description: Unique party identifier schema: type: string format: uuid example: 7e3b9c2a-1f4d-4a8b-9c11-2d6e8f0a1b22 schemas: SinglePartyPartnerOnboardingResponse: allOf: - $ref: '#/components/schemas/BaseResponse' - type: object properties: result: $ref: '#/components/schemas/PartyPartnerOnboarding' BaseResponse: type: object properties: success: type: boolean description: Indicates whether the request was successful PartyPartnerOnboarding: type: object description: > A party's partner-onboarding status. Unlike partner-terms, the body carries no URL — there is nothing for the end customer to do here. Reading it never triggers a provisioning attempt. required: - partyId - status properties: partyId: type: string format: uuid status: $ref: '#/components/schemas/PartnerOnboardingStatus' 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 PartnerOnboardingStatus: type: string description: > Where the party stands with our banking partner's own recipient checks — a gate separate from identity verification and from partner-terms consent. - `NOT_STARTED` — not yet relayed to a partner - `PENDING` — relayed; the partner is still verifying. Provisioning answers `409 partner-onboarding-pending` - `APPROVED` — the partner-onboarding gate is satisfied - `REJECTED` — declined or revoked. Provisioning answers `422 partner-onboarding-rejected`; re-requesting onboarding re-attempts it enum: - NOT_STARTED - PENDING - APPROVED - REJECTED 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: {} ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.