Skip to main content

Overview

The getBusiness query returns the current KYB status for a business account, together with a snapshot of the ownership roster and where each owner stands in identity verification. It is how you answer two different questions after registering a business:
  • Is the business approved yet? Read kybStatus.
  • What is holding it up? Read owners — an owner still on PENDING_CIP or PENDING_INVITE is usually the answer.
You can also receive status changes by subscribing to the KYB_STATUS_UPDATE webhook, which avoids scheduled reads. The webhook carries the business status only, so call this query when you need the owner roster. See Tracking an application.

Required scopes

The query takes no arguments — it always resolves the business tied to the calling token’s accountId. Use a token minted for the business account that registerBusiness returned; the consumer token you registered with will not work.
When Fluz creates the business OAuth grant during registration, REGISTER_BUSINESS is force-included in that grant’s scopes, so a token minted for the new business account can always call this query.

Basic query structure

Response details

BusinessOwnerStatus

ExternalKybStatus (enum)

registerBusiness returns SUBMITTED, which is not a value of this enum — that same moment reads as PENDING here.
PENDING collapses several internal states into one value. That matters in one place: requestOwnerDocumentVerificationLink only works while the case is in one specific internal state, and kybStatus cannot tell you which one you are in.

BusinessOwnerVerificationType (enum)

ExternalBusinessOwnerStatus (enum)

cURL Example

Example Response

Jane needs a verification link. Carol was invited and will be emailed by Fluz. The business cannot be approved until both reach READY.

Error Codes

This query returns all failures in the top-level errors array — there is no success: false payload.

Best practices

  • Prefer the webhook, read for reconciliation. Subscribe to KYB_STATUS_UPDATE for latency, and read this query when the user returns to your onboarding screen or on a low-frequency background schedule — hourly, not per page load.
  • Wait for both signals before going live. kybStatus: APPROVED and every owner at READY.
  • Do not treat a link request as progress. An owner’s status changes when they actually complete verification, not when you generate their link.

KYB overview

The status lifecycle and how to track a case to a decision.

Owner verification link

Generate a link for owners reported as DOCUMENTS and PENDING_CIP.

Register a business

The mutation that creates the account this query reads.