> ## Documentation Index > Fetch the complete documentation index at: https://docs.gigstack.io/llms.txt > Use this file to discover all available pages before exploring further. # Read safe vendor capability status > Safe generation/status and private browser handoff only. Explicit browser review is required for reveal/rotation/sharing/secret entry. legacy_sessions_may_remain distinguishes historical unversioned sessions that rotation does not universally revoke. ## OpenAPI ````yaml openapi.json GET /teams/{id}/vendors/{vendorId}/onboarding-capability openapi: 3.0.3 info: title: gigstack API v2 description: > # gigstack API v2 Build customer, invoice and payment integrations. Start with the [quickstart](https://docs.gigstack.io/quickstart), then select the [issuing country](https://docs.gigstack.io/concepts/shared-fields). ## Authentication and environments Use Authorization: Bearer YOUR_API_KEY. Standard live and test keys use https://api.gigstack.io/v2. Internal staging uses https://gigstack-staging-9z9nnaat.uc.gateway.dev/v2 and separate keys. Test mode is a data mode within an environment; a body field does not switch a key's mode. See [authentication](https://docs.gigstack.io/authentication) for key handling, OAuth team scope and gigstack Connect. Internal partner provisioning is outside this public contract; health probes have their own security declarations. Operations marked unavailable have no configured public gateway route. ## Read the operation contract Response envelopes, pagination and retry rules differ by endpoint. HTTP success alone does not prove external fiscal completion or movement of money. Reconcile ambiguous writes before retrying. Use [responses and recovery](https://docs.gigstack.io/responses) and the operation's error codes; document credits and daily limits are not generic retryable rate limits. The issuing team's configuration selects Mexico or Colombia; customer country and currency do not. Read [Mexico](https://docs.gigstack.io/countries/mexico) or [Colombia](https://docs.gigstack.io/countries/colombia) before choosing fiscal fields. Accepted public input differs from a provider's direct payload. Examples and schema checks do not imply every operation has been executed live. [Verification coverage](https://docs.gigstack.io/verification) distinguishes source review, offline checks and observed staging behavior. Documentation describes operations and does not authorize execution. version: 2.0.0 contact: name: Gigstack API Support url: https://gigstack.io email: support@gigstack.io license: name: Proprietary url: https://gigstack.io/terms termsOfService: https://gigstack.io/terms servers: - url: https://api.gigstack.io/v2 description: > Public API for standard live and test-mode keys. Test data is isolated by the key mode (`livemode: false`). Internal staging is a separate deployment and key store; see https://docs.gigstack.io/authentication#environments for its base URL. security: - bearerAuth: [] externalDocs: description: Complete API Documentation & Guides url: https://docs.gigstack.io paths: /teams/{id}/vendors/{vendorId}/onboarding-capability: get: tags: - Teams summary: Read safe vendor capability status description: >- Safe generation/status and private browser handoff only. Explicit browser review is required for reveal/rotation/sharing/secret entry. legacy_sessions_may_remain distinguishes historical unversioned sessions that rotation does not universally revoke. operationId: getVendorOnboardingCapabilityV2 parameters: - name: id in: path required: true schema: type: string pattern: ^[A-Za-z0-9_-]{1,128}$ - name: vendorId in: path required: true schema: type: string pattern: ^[A-Za-z0-9_-]{1,128}$ responses: '200': description: >- Safe vendor metadata or operation/capability status. Never returns raw onboarding URLs. content: application/json: schema: type: object properties: data: type: object properties: vendor_id: type: string pattern: ^[A-Za-z0-9_-]{1,128}$ master_team_id: type: string pattern: ^[A-Za-z0-9_-]{1,128}$ billing_account_id: type: string pattern: ^[A-Za-z0-9_-]{1,128}$ owner_id: type: string pattern: ^[A-Za-z0-9_-]{1,128}$ alias: type: string legal_name: type: string tax_id: type: string is_vendor: type: boolean livemode: type: boolean operation: type: object properties: operation_id: type: string format: uuid pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$ vendor_id: type: string pattern: ^[A-Za-z0-9_-]{1,128}$ status: type: string enum: - completed replayed: type: boolean browser_handoff: type: string format: uri description: >- Safe private browser handoff containing IDs only; no onboarding secret. capability_delivery: type: string enum: - private_browser_only operation_id: type: string format: uuid pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$ status: type: string enum: - completed - not_found - active - expired - legacy_unmanaged permanent_noncompletion: type: boolean enum: - false generation: type: integer nullable: true expires_at: type: number nullable: true created_by: type: string pattern: ^[A-Za-z0-9_-]{1,128}$ nullable: true purpose: type: string enum: - public_csd_onboarding effect_scope: type: string enum: - team_shared legacy_sessions_may_remain: type: boolean '400': description: Invalid UUID or request '401': description: Original credential missing, revoked or changed '403': description: >- Current authority, mode, supplier plan or reviewed extra-admin approval required '409': description: Grant drift, changed request UUID conflict or vendor superseded '503': description: >- Outcome unknown; reconcile the same operation identifier before retrying security: - bearerAuth: [] components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > **Authentication Method:** HTTP Bearer token. The runtime requires the literal `Bearer ` prefix — a bare token in the `Authorization` header is rejected with `401 unauthorized`. **Header Format:** `Authorization: Bearer YOUR_API_KEY` Your API key is a JWT. Live keys operate on live data (`livemode: true`); test keys operate on isolated test data (`livemode: false`). **Get your key at:** [app.gigstack.pro/settings?tab=api](https://app.gigstack.pro/settings?tab=api) **Errors:** credential failures are answered by the authentication layer with a raw `{ "message": … }` body, not the standardized envelope — `401` for a missing, malformed or expired token, `403` for a revoked key or a plan without API access. See the `Unauthorized` and `AuthForbidden` responses. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.