Check whether your organization or child organization has completed KYC or KYB so you can decide if the next onboarding or production step is allowed.

⏱️
Time to integrate: Most teams can validate this endpoint in under 5 minutes once API access is configured. It should be part of every onboarding and go-live checklist.

What this endpoint does

Use this endpoint to retrieve the current verification state for an organization or child organization.

This endpoint is the operational source of truth for whether your team should:

continue collecting onboarding data
wait for review
correct missing or invalid submission details
proceed with integration milestones
prepare for production launch

When to call this endpoint

Call this endpoint when you need to:

check current KYC or KYB progress
confirm whether verification is complete before moving to production workflows
troubleshoot onboarding delays
validate readiness for a partner-managed child organization

This endpoint is especially useful after document submission, before production launch, and whenever onboarding status is unclear.

Authentication

Send your API key in the x-api-key header on every request.

Item	Value
Authentication method	API key
Required header	`x-api-key`
Rate limit scope	Per API key

How to use this endpoint in your workflow

Use verification status as a decision point, not only as a reporting field.

Recommended workflow

Submit required KYC or KYB information.
Call this endpoint to confirm the current verification state.
If verification is not complete, stop production-specific actions.
If verification is complete, continue with account setup, funding checks, quote generation, and transaction execution.

For partner integrations, repeat this process for each child organization that must be verified independently.

KYC and KYB usage

Use the endpoint to check whichever verification type applies to your entity model.

KYC (Know Your Customer): usually applies to an individual or sole trader
KYB (Know Your Business): usually applies to a business entity or institution

Your internal workflow should always match the verification type required for the organization you are transacting under.

What to do with the response

Use the returned verification state to decide the next action.

If verification is complete

Proceed with:

confirming account availability
validating beneficiary setup
preparing production launch steps
enabling live transaction workflows if your organization is approved for production

If verification is pending or under review

Do not assume production readiness.

Instead:

pause production-specific setup tasks
monitor status through this endpoint
keep your team aligned on the current approval state

If verification is incomplete

Review the submitted onboarding data and provide the missing information through the approved onboarding process.

If verification is rejected

Do not retry live flows blindly. First identify the reason, correct the underlying issue, and resubmit through the approved onboarding path.

⚠️
Needs confirmation: Exact status values, status transition rules, rejection reason codes, and whether sandbox or production access depends on specific statuses are not yet defined in this page.

Common use cases

Onboarding progress checks

Use this endpoint after document submission so engineering, compliance, and operations teams all rely on the same current status.

Production gating

Use this endpoint before you switch to live credentials, fund production accounts, or execute first live transactions.

Partner and marketplace workflows

If your operating model includes sub-businesses, use this endpoint to verify whether a child organization is approved before enabling its transaction flows.

Production notes

Before you use this endpoint as part of a launch workflow:

Define internally which returned states block launch.
Record verification checks in your release checklist.
Require a successful verification check before first live transaction execution.
Recheck the status if onboarding data changes close to launch.

This endpoint should be part of your release controls, not only your onboarding workflow.

Common failure cases

Authentication fails

Check these items first:

the x-api-key header is present
the key belongs to the intended environment
the base URL is correct

The returned status is unclear to the team

If your team cannot act on the returned value:

stop relying on assumptions or manual status updates
map the returned state to an internal decision such as proceed, wait, or resubmit
escalate for clarification only after capturing the raw response

Child organization checks are inconsistent

If you manage multiple business entities:

verify that the correct organization or child organization context is being checked
avoid mixing parent-level and child-level approval assumptions

⚠️
Needs confirmation: Parameter requirements for selecting verification type or child organization context should be confirmed in the API definition.