OpenapiCompany
Reports the founders whose KYC is not yet settled, oldest formation first, so…
Reports the founders whose KYC is not yet settled, oldest formation first, so the queue drains in the order founders have been waiting.
GET /v1/company/review
| Address | https://api.hanzo.ai/v1/company/review |
| Method | GET |
| Operation | get_company_review |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Reports the founders whose KYC is not yet settled, oldest formation first, so the queue drains in the order founders have been waiting. A Hanzo platform operation: a caller who is not a platform reviewer gets 403.
It only says who is waiting; the decision itself is POST /v1/company/kyc/decision.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | integer | — | Limit bounds how many formations are scanned; 0 or less means the default of 200. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | reviewQueue | ok |
200 body — 9 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
count | body | integer | — | Count is how many founders are waiting. |
queue | body | waiting[] | — | Queue is one entry per unsettled founder, oldest formation first. |
queue[].email | body | string | — | Email is the founder's email — the key a decision is posted against. |
queue[].founder | body | string | — | Founder is the founder's name. |
queue[].kycRef | body | string | — | KYCRef is the identity-verification session reference, when one was opened. |
queue[].kycStatus | body | string | — | KYCStatus is the founder's unsettled status. |
queue[].name | body | string | — | Name is the proposed company name. |
queue[].org | body | string | — | Org is the tenant whose formation the founder belongs to. |
queue[].since | body | integer | — | Since is when the formation was last touched, as a unix second. |
Failure carries the platform error shape — see Errors.
Examples
hanzo company reviewimport { Configuration, CompanyApi } from 'hanzoai';
const api = new CompanyApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getCompanyReview();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import CompanyApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = CompanyApi(client).get_company_review()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.CompanyAPI.GetCompanyReview(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, company_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = company_api::get_company_review(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.CompanyApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new CompanyApi(client).getCompanyReview();curl https://api.hanzo.ai/v1/company/review \
-H "Authorization: Bearer $HANZO_API_KEY"Tool company, op get_company_review — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "company",
"arguments": {
"op": "get_company_review",
"input": {}
}
}
}'How is this guide?