Skip to main content
POST
Create a new risk assessment for a company.

Request body

string
required
Assessment name or identifier.Maximum length: 200 characters.
string
required
Name of the company being assessed.Maximum length: 200 characters.
string
Type or category of company (e.g., “Cooperative”, “Private Company”, “SME”).Maximum length: 100 characters.
string
Country where the company operates.Defaults to “Kenya” if not provided. Maximum length: 100 characters.
string
required
Method for collecting assessment data.Allowed values:
  • UPLOAD - Upload documents for automated analysis
  • GUIDED_INTERVIEW - Step-by-step questionnaire
  • MANUAL_ENTRY - Direct data entry

Response

string
Unique assessment identifier (UUID).
string
Assessment name.
string
Company name.
string
Company type.
string
Country of operation.
string
Current assessment status.Values:
  • DRAFT - Initial state, data collection in progress
  • ANALYZING - AI analysis in progress
  • ACTION_REQUIRED - Waiting for user input or gap resolution
  • COMPLETE - Assessment and report complete
string
Data collection method used.
number
Completion percentage (0-100).
number
Version number for optimistic locking.
number
Aggregated risk score across all categories (0-100). Null until analysis is complete.
string
Overall risk classification. Null until analysis is complete.Values: LOW, MODERATE, HIGH, CRITICAL
string
ID of the user who created the assessment.
string
ISO 8601 timestamp of creation.
string
ISO 8601 timestamp of last update.