What are Entities?
Entities are the core objects in gu1 that represent the subjects of your risk analysis. An entity can be a company, an individual, a transaction, or any custom type relevant to your business. Each entity contains:- Identity information (name, external ID, type)
- Risk assessment (risk score, status)
- Custom data (flexible JSON for your specific fields)
- Relationships (connections to other entities)
- Analysis results (AI-powered insights)
- Timeline (history of changes and events)
Entity Types
Company
Corporate entities for KYB analysis
Person
Individual entities for KYC analysis
Transaction
Financial transactions for monitoring
Custom
Any custom entity type for your business
Entity Lifecycle
1
Creation
Entity is created via API with basic information and optional custom data
2
Enrichment
Additional data is added through updates or integrations
3
Analysis
AI-powered risk analysis is automatically generated
4
Rule Evaluation
Risk rules are applied to calculate risk score and generate alerts
5
Investigation
Alerts trigger investigations for manual review
6
Resolution
Entity status is updated based on investigation outcomes
Entity Status
Entities can have different statuses throughout their lifecycle:| Status | Description | Use Case |
|---|---|---|
| active | Entity is active and being monitored | Normal operation |
| inactive | Entity is no longer active | Closed accounts |
| under_review | Entity is being investigated | Alert triggered |
| approved | Entity passed all checks | Low risk |
| rejected | Entity failed compliance checks | High risk |
| suspended | Entity temporarily suspended | Pending information |
Risk Scoring
Every entity has a risk score (0-100) calculated based on:AI Analysis
AI Analysis
Machine learning models analyze entity behavior, patterns, and anomalies
Rule-Based Scoring
Rule-Based Scoring
Custom rules evaluate specific conditions and assign risk points
Compliance Checks
Compliance Checks
Sanctions lists, PEPs, adverse media screening results
Historical Behavior
Historical Behavior
Transaction patterns, account activity, and changes over time
Relationship Analysis
Relationship Analysis
Connected entities and their risk profiles
- 0-25: Low risk (green)
- 26-50: Medium risk (yellow)
- 51-75: High risk (orange)
- 76-100: Critical risk (red)
Entity Data Structure
Core Fields
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | Entity type (company, person, transaction, custom) |
name | string | Yes | Entity name |
externalId | string | No | Your unique identifier for this entity |
country | string | No | ISO country code (e.g., “US”, “UK”) |
entityData | object | No | Flexible JSON for custom fields |
riskScore | number | No | Risk score 0-100 (auto-calculated) |
status | enum | No | Entity status (default: “active”) |
Custom Entity Data
TheentityData field is a flexible JSON object where you can store any custom fields relevant to your use case:
KYB Example:
Common Operations
Create Entity
POST /entities - Create new entity
Get Entity
GET /entities/:id - Retrieve entity details
List Entities
GET /entities - Query entities with filters
Update Entity
PUT /entities/:id - Update entity data
Delete Entity
DELETE /entities/:id - Remove entity
Bulk Import
POST /entities/bulk - Import multiple entities
Best Practices
Use External IDs
Use External IDs
Always set
externalId to your internal identifier for easy reconciliation and updatesConsistent Entity Types
Consistent Entity Types
Use consistent entity type values across your organization (e.g., “company” vs “corporate”)
Set Country Codes
Set Country Codes
Always include ISO country codes for proper risk assessment and compliance checks
Structure Entity Data
Structure Entity Data
Organize
entityData with consistent field names and nested objects for complex dataTrack Updates
Track Updates
Use the
updatedAt timestamp to detect changes and sync with your systemsBulk Operations
Bulk Operations
Use bulk import for creating multiple entities (>10) to improve performance
Advanced Features
AI-Powered Analysis
Every entity can have AI-generated risk analysis:- Executive summary
- Behavioral patterns
- Risk factors identified
- Recommendations
- Confidence score
Entity Relationships
Connect entities to show ownership, transactions, or other relationships:Document Attachments
Attach documents (ID cards, licenses, contracts) to entities:Example Workflows
KYB Onboarding
Complete company onboarding workflow
KYC Verification
Individual customer verification process
Transaction Monitoring
Real-time transaction screening
Ongoing Monitoring
Continuous entity monitoring setup
Next Steps
1
Create Your First Entity
Follow the Create Entity guide to add an entity
2
Setup Data Mapping
Use Custom Schemas for structured imports
3
Configure Rules
Apply risk rules through the dashboard to calculate risk scores
4
Monitor & Act
Setup webhooks to receive alerts when risk scores change