REST API›Organization›Enterprise Management

GET

Get enterprise summary for an organization

Returns counts of CaaS child enterprises grouped by KYC state and account type.

Path Params

  • organizationId string required
    The organization ID

Responses

200
OK

Response Body

object

  • totalCount number required
    Total number of CaaS child enterprises in the organization.

    >= 0

  • byKycState object required
    Enterprise counts grouped by KYC state.
    byKycState object
    • unverified number required
    • approved number required
    • rejected number required
    • pending number required
  • byAccountTypeAndKycState object required
    Enterprise counts grouped by account type and KYC state.
    byAccountTypeAndKycState object
    • individual object required
      Count of enterprises per enterprise KYC state. All known states are 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 enterprise KYC state. All known states are present; absent states default to 0.
      entity object
      • Same shape as KycStateCounts.
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