Skip to main content
POST
/
v1
/
company
/
ai-overview
curl -X POST https://api.vouchmark.com/v1/company/ai-overview \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"businessId": "cmp_aBcD..."}'
{
  "success": true,
  "businessId": "cmp_aBcD...",
  "companyId": "cmp_aBcD...",
  "companyName": "TEKCIFY TECHNOLOGIES LTD",
  "rcNumber": "RC1234567",
  "overview": "## TEKCIFY TECHNOLOGIES LTD\n\nTekcify Technologies Ltd is a verified Nigerian technology company...\n\n### Verification\n- CAC Certificate verified\n- Tax Clearance verified\n\n### Risk profile\nOverall risk is LOW with one active monitoring concern...",
  "sources": {
    "searchSuggestions": "<rendered search suggestions html or null>",
    "groundingChunks": [
      { "web": { "uri": "https://...", "title": "Source" } }
    ]
  }
}
Generates a Markdown executive summary of a company, combining its verification data, monitoring signals, and public information. The overview is generated fresh each time and not cached.
Requires a positive wallet balance and is metered per AI request (₦100 per 1,000 tokens), rate limited to 10 AI requests per minute. Each user may generate an overview for a given company once; further attempts return 403.

Body

businessId
string
required
The company to generate an overview for. Note the field is businessId, not companyId.
curl -X POST https://api.vouchmark.com/v1/company/ai-overview \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"businessId": "cmp_aBcD..."}'
{
  "success": true,
  "businessId": "cmp_aBcD...",
  "companyId": "cmp_aBcD...",
  "companyName": "TEKCIFY TECHNOLOGIES LTD",
  "rcNumber": "RC1234567",
  "overview": "## TEKCIFY TECHNOLOGIES LTD\n\nTekcify Technologies Ltd is a verified Nigerian technology company...\n\n### Verification\n- CAC Certificate verified\n- Tax Clearance verified\n\n### Risk profile\nOverall risk is LOW with one active monitoring concern...",
  "sources": {
    "searchSuggestions": "<rendered search suggestions html or null>",
    "groundingChunks": [
      { "web": { "uri": "https://...", "title": "Source" } }
    ]
  }
}
overview is a Markdown string, not a structured object — render it as Markdown. sources is null when the model did not ground its answer with web search; when present it carries searchSuggestions and up to five groundingChunks. When the per-company generation limit has already been reached, the endpoint returns 403:
{
  "success": false,
  "message": "You can generate overview once for this company, you can continue on vouch ai on dashboard"
}