REST API›Organization›Enterprise Management

GET

Org enterprise inventory summary for an organization

Returns inventory headline counts plus verification state breakdowns for individual (KYC) and entity (KYB) enterprises

Path Params

  • organizationId string required
    The organization ID

Query Params

  • businessModel array of string enums
    Filter by one or more business models. Repeatable: ?businessModel=cryptoAsAServiceChild&businessModel=bitgoAsAService When omitted, all enterprises in the org are included in inventory counts.
    bitgoAsAServicecryptoAsAServiceParentcryptoAsAServiceChild

Responses

200
OK

Response Body

object

  • inventory object required
    Headline enterprise inventory counts for the organization matching the applied filter.
    inventory object
    • totalCount number required
      Non-deleted enterprises matching the filter (activeCount + archivedCount).

      >= 0

    • activeCount number required
      Non-deleted, non-archived enterprises matching the filter.

      >= 0

    • archivedCount number required
      Non-deleted, archived enterprises matching the filter.

      >= 0

    • frozenCount number required
      Non-deleted enterprises matching the filter with an active freeze (freeze.expires >= now). May overlap with activeCount or archivedCount.

      >= 0

    • deletedCount number required
      Soft-deleted enterprises matching the filter.

      >= 0

  • byVerificationState object required
    Verification state counts across all non-deleted enterprises matching the filter. Unknown verification states are excluded here but still counted in inventory.totalCount.
    byVerificationState object
    • unverified number required
    • approved number required
    • rejected number required
    • pending number required
  • byAccountTypeAndVerificationState object required
    Verification state counts split by account type (individual KYC, entity KYB). Missing or unknown accountType values are excluded here but still counted in inventory.totalCount and byVerificationState.
    byAccountTypeAndVerificationState object
    • individual object required
      Count of enterprises per verification state (KYC for individual, KYB for entity). All known states are always present; absent states default to 0.
      individual object
      • unverified number required
      • approved number required
      • rejected number required
      • pending number required
    • entity object required
      Count of enterprises per verification state (KYC for individual, KYB for entity). All known states are always present; absent states default to 0.
      entity object
      • Same shape as VerificationStateCounts.
400
Bad Request

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
401
Unauthorized

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
403
Forbidden

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
404
Not Found

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
500
Internal Server Error

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id