Skip to main content
GET
Get KYB status

Authorizations

Authorization
string
header
required

API key sent in the Authorization header, with no Bearer prefix.

Path Parameters

organizationId
string<uuid>
required

The organization this call acts for: your API key's organization or one of its customer organizations. Any other id returns 404 not-found.

Response

The organization's KYB status.

organizationId
string<uuid>
required
status
enum<string>
required
  • notStarted: verification has not started.
  • inProgress: the customer started but has not submitted everything.
  • submitted: submitted and waiting for review.
  • approved: cleared.
  • denied: rejected, or a previous approval was revoked.
Available options:
notStarted,
inProgress,
submitted,
approved,
denied
approvedAt
string<date-time> | null
required

When the business was approved. Null until then.