# gu1

## Docs

- [Acknowledge Alert](https://docs.gu1.ai/en/api-reference/alerts/acknowledge.md): Mark an alert as acknowledged
- [Mark Alert as False Positive](https://docs.gu1.ai/en/api-reference/alerts/false-positive.md): Mark an alert as a false positive
- [Get Intelligence Inbox](https://docs.gu1.ai/en/api-reference/alerts/inbox.md): Get aggregated inbox with cases and alerts
- [List Alerts](https://docs.gu1.ai/en/api-reference/alerts/list.md): Get alerts for entities or organizations with filtering and pagination
- [Resolve Alert](https://docs.gu1.ai/en/api-reference/alerts/resolve.md): Mark an alert as resolved
- [Authentication](https://docs.gu1.ai/en/api-reference/authentication.md): Learn how to authenticate with the gu1 API using API keys
- [Archive automation](https://docs.gu1.ai/en/api-reference/automations/archive-automation.md): Soft-delete (archive) an automation so it no longer runs.
- [Cancel execution (standby)](https://docs.gu1.ai/en/api-reference/automations/cancel-execution.md): Cancel a paused workflow execution by execution ID, by automation ID, or via link with token.
- [Continue execution (standby)](https://docs.gu1.ai/en/api-reference/automations/continue-execution.md): Resume a paused workflow: by execution ID (POST or link), or by automation ID.
- [Create automation](https://docs.gu1.ai/en/api-reference/automations/create-automation.md): Create a new automation (workflow). Validates trigger type, graph shape, and workflow synergy.
- [Execute automation (test)](https://docs.gu1.ai/en/api-reference/automations/execute-automation.md): Run a test execution with synthetic data from the org. Uses processEvent — no standby.
- [Get execution context (waiting)](https://docs.gu1.ai/en/api-reference/automations/execution-context.md): Read the saved event data snapshot for a waiting execution (e.g. for UI display).
- [Get automation](https://docs.gu1.ai/en/api-reference/automations/get-automation.md): Retrieve a single automation by ID, including recent executions.
- [List automations](https://docs.gu1.ai/en/api-reference/automations/list-automations.md): List all automations for the organization with optional filters.
- [List executions](https://docs.gu1.ai/en/api-reference/automations/list-executions.md): Paginated execution history for one automation.
- [Restore automation](https://docs.gu1.ai/en/api-reference/automations/restore-automation.md): Restore an archived automation.
- [Run automation (manual API)](https://docs.gu1.ai/en/api-reference/automations/run-automation.md): Production run via API. Only for automations with trigger manual_execution. Supports standby.
- [List templates](https://docs.gu1.ai/en/api-reference/automations/templates.md): Read-only automation templates (may include a pre-built graph for the builder).
- [Toggle automation](https://docs.gu1.ai/en/api-reference/automations/toggle-automation.md): Enable or disable an automation without deleting it.
- [Update automation](https://docs.gu1.ai/en/api-reference/automations/update-automation.md): Partially update an automation. Re-validates synergy when graph/steps/actions change.
- [List waiting executions](https://docs.gu1.ai/en/api-reference/automations/waiting-executions.md): List automation executions in standby (waiting) for the organization.
- [Change external ID](https://docs.gu1.ai/en/api-reference/company/change-external-id.md): Set a new external identifier with a mandatory audit reason; updates denormalized transaction and user event references when applicable.
- [Create](https://docs.gu1.ai/en/api-reference/company/create.md): Create a new company with custom data
- [Create Automatically](https://docs.gu1.ai/en/api-reference/company/create-automatic.md): Automatically create company with enriched data from registries
- [Get](https://docs.gu1.ai/en/api-reference/company/get.md): Retrieve detailed information about a company
- [List](https://docs.gu1.ai/en/api-reference/company/list.md): Query and filter companys in your organization
- [Update](https://docs.gu1.ai/en/api-reference/company/update.md): Update attributes and data for an existing company
- [Update Entity by External ID](https://docs.gu1.ai/en/api-reference/company/update-by-external-id.md): Update an entity using your external identifier instead of the internal UUID
- [Upsert](https://docs.gu1.ai/en/api-reference/company/upsert.md): Create or update with duplicate detection
- [Custom Schemas](https://docs.gu1.ai/en/api-reference/data-ingestion/custom-schemas.md): Define and manage custom data schemas for flexible data ingestion
- [Field Mappings](https://docs.gu1.ai/en/api-reference/data-ingestion/field-mappings.md): Map your data fields to gu1 entity model with transformations
- [Data Ingestion Overview](https://docs.gu1.ai/en/api-reference/data-ingestion/overview.md): Learn how to map and import your data into gu1 using custom schemas and field mappings
- [Create](https://docs.gu1.ai/en/api-reference/devices/create.md): Register a device for an entity
- [List](https://docs.gu1.ai/en/api-reference/devices/list.md): Get all devices for an entity
- [Overview](https://docs.gu1.ai/en/api-reference/devices/overview.md): Track and monitor devices used by your entities for fraud detection and security
- [Upload Document](https://docs.gu1.ai/en/api-reference/documents/upload.md): Upload a document and optionally associate it with an entity and category
- [Execute Enrichment by External ID](https://docs.gu1.ai/en/api-reference/enrichment/execute-by-external-id.md): Execute marketplace enrichment integrations on an entity using your own external identifier
- [Execute Enrichment by Entity ID](https://docs.gu1.ai/en/api-reference/enrichment/execute-by-id.md): Execute marketplace enrichment integrations on an entity using its internal ID
- [Enrichment Overview](https://docs.gu1.ai/en/api-reference/enrichment/overview.md): Execute marketplace enrichment integrations to gather additional entity data from external providers
- [Analyze Entity](https://docs.gu1.ai/en/api-reference/entities/analyze.md): Manual risk analysis of entity using rules engine
- [Country Requirements](https://docs.gu1.ai/en/api-reference/entities/country-requirements.md): Get validation requirements for different countries
- [Entity Types](https://docs.gu1.ai/en/api-reference/entities/entity-types.md): Available entity types in the universal entity system
- [Materialize relationships](https://docs.gu1.ai/en/api-reference/entities/materialize-relationships.md): Create or update shareholders and related entities from normalized enrichment (Brazil and supported countries)
- [Entities Overview](https://docs.gu1.ai/en/api-reference/entities/overview.md): Manage companies, individuals, and transactions in gu1 risk analysis platform
- [Tax ID Formats by Country](https://docs.gu1.ai/en/api-reference/entities/tax-id-formats.md): Complete guide to accepted Tax ID formats for each country and entity type
- [Production & Sandbox Environments](https://docs.gu1.ai/en/api-reference/environments.md): Understand how to use Production and Sandbox environments to test safely before going live
- [Create](https://docs.gu1.ai/en/api-reference/events/create.md): Create a user event for fraud detection and rule validation
- [List](https://docs.gu1.ai/en/api-reference/events/list.md): Query user events with advanced filters
- [List by Entity](https://docs.gu1.ai/en/api-reference/events/list-by-entity.md): Get all events for a specific entity
- [Overview](https://docs.gu1.ai/en/api-reference/events/overview.md): Track user actions and behaviors for fraud detection, compliance monitoring, and analytics
- [Statistics](https://docs.gu1.ai/en/api-reference/events/stats.md): Get aggregated event statistics by type
- [Company Provider Codes](https://docs.gu1.ai/en/api-reference/integrations/company-provider-codes.md): Available provider codes for company entity enrichment
- [Execute marketplace enrichment without entity](https://docs.gu1.ai/en/api-reference/integrations/execute-without-entity.md): Run a single marketplace enrichment from tax ID and/or name without persisting an entity; optional cache-only mode.
- [List headless enrichment executions](https://docs.gu1.ai/en/api-reference/integrations/headless-executions.md): Paginated, filterable read-only list of headless marketplace enrichment audit rows for the current organization.
- [Get headless enrichment execution by id](https://docs.gu1.ai/en/api-reference/integrations/headless-executions-item.md): Returns one headless audit row by UUID, including merged resultSummary when cache still exists.
- [Person Provider Codes](https://docs.gu1.ai/en/api-reference/integrations/person-provider-codes.md): Available provider codes for person entity enrichment
- [Shared Provider Codes](https://docs.gu1.ai/en/api-reference/integrations/shared-provider-codes.md): Provider codes that work for both Person and Company entities
- [Assign Investigation](https://docs.gu1.ai/en/api-reference/investigations/assign.md): Assign investigation to user or team
- [Get Investigation Alerts](https://docs.gu1.ai/en/api-reference/investigations/get-alerts.md): Get all alerts linked to an investigation
- [List Investigations](https://docs.gu1.ai/en/api-reference/investigations/list.md): Get investigations for an entity
- [Update Investigation Status](https://docs.gu1.ai/en/api-reference/investigations/update-status.md): Change investigation status
- [Messaging overview](https://docs.gu1.ai/en/api-reference/messaging/overview.md): Send transactional email and SMS via the API: prerequisites, billing, custom senders, and templates
- [Send email](https://docs.gu1.ai/en/api-reference/messaging/send-email.md): POST /marketplace/messaging/send-email — transactional email with optional template or inline HTML
- [Send SMS](https://docs.gu1.ai/en/api-reference/messaging/send-sms.md): POST /marketplace/messaging/send-sms — transactional SMS with optional template or inline body
- [Create Payment Method](https://docs.gu1.ai/en/api-reference/payment-methods/create.md): Create a new payment method entity
- [Get Payment Method](https://docs.gu1.ai/en/api-reference/payment-methods/get.md): Retrieve a payment method entity by ID
- [List Payment Methods](https://docs.gu1.ai/en/api-reference/payment-methods/list.md): List all payment method entities with filtering and pagination
- [Payment Methods Overview](https://docs.gu1.ai/en/api-reference/payment-methods/overview.md): Managing payment methods as entities in the Güeno platform
- [Update Payment Method](https://docs.gu1.ai/en/api-reference/payment-methods/update.md): Update a payment method entity
- [Change external ID](https://docs.gu1.ai/en/api-reference/person/change-external-id.md): Set a new external identifier with a mandatory audit reason; updates denormalized transaction and user event references when applicable.
- [Create](https://docs.gu1.ai/en/api-reference/person/create.md): Create a new person with custom data
- [Create Automatically](https://docs.gu1.ai/en/api-reference/person/create-automatic.md): Automatically create person with enriched data from registries
- [Get](https://docs.gu1.ai/en/api-reference/person/get.md): Retrieve detailed information about a person
- [List](https://docs.gu1.ai/en/api-reference/person/list.md): Query and filter persons in your organization
- [Update](https://docs.gu1.ai/en/api-reference/person/update.md): Update attributes and data for an existing person
- [Update Entity by External ID](https://docs.gu1.ai/en/api-reference/person/update-by-external-id.md): Update an entity using your external identifier instead of the internal UUID
- [Upsert](https://docs.gu1.ai/en/api-reference/person/upsert.md): Create or update with duplicate detection
- [Create Risk Matrix](https://docs.gu1.ai/en/api-reference/risk-matrix/create.md): Create a new risk matrix with triggers
- [Get Risk Matrix](https://docs.gu1.ai/en/api-reference/risk-matrix/get.md): Get a specific risk matrix with its rules
- [List Risk Matrices](https://docs.gu1.ai/en/api-reference/risk-matrix/list.md): Get all risk matrices for organization
- [Update Risk Matrix](https://docs.gu1.ai/en/api-reference/risk-matrix/update.md): Update risk matrix configuration
- [Rules Execution Summary](https://docs.gu1.ai/en/api-reference/rules-execution-summary.md): Complete structure of the rulesExecutionSummary object returned by the rules engine
- [Condition Fields Reference](https://docs.gu1.ai/en/api-reference/rules/conditions.md): Complete reference of available fields for rule conditions by entity type and country
- [Create Rule](https://docs.gu1.ai/en/api-reference/rules/create.md): Create a new rule for risk detection and compliance monitoring
- [Execute Rule](https://docs.gu1.ai/en/api-reference/rules/execute.md): Execute a rule against a specific entity for testing and validation
- [Get Rule](https://docs.gu1.ai/en/api-reference/rules/get.md): Retrieve details of a specific rule by ID
- [List Rules](https://docs.gu1.ai/en/api-reference/rules/list.md): Query and filter rules with pagination
- [Update Rule](https://docs.gu1.ai/en/api-reference/rules/update.md): Update an existing rule configuration
- [Create Transaction](https://docs.gu1.ai/en/api-reference/transactions/create.md): Create a new financial transaction for monitoring and analysis
- [Create Batch Transactions](https://docs.gu1.ai/en/api-reference/transactions/create-batch.md): Create multiple transactions in a single API call for high-throughput scenarios
- [Get Transaction](https://docs.gu1.ai/en/api-reference/transactions/get.md): Retrieve a single transaction by internal ID or external ID
- [Payment Details Schema](https://docs.gu1.ai/en/api-reference/transactions/payment-details-schema.md): Optional structures for originDetails.paymentDetails and destinationDetails.paymentDetails
- [Transaction Reason Enum](https://docs.gu1.ai/en/api-reference/transactions/reason-enum.md): Complete list of transaction_reason_type values for Create Transaction and rules
- [Changelog](https://docs.gu1.ai/en/changelog.md): Latest updates and improvements to gu1 documentation
- [Dashboard sessions (one device at a time)](https://docs.gu1.ai/en/dashboard-session-policy.md): How gu1 dashboard login behaves when you use multiple browsers or devices
- [Welcome to gu1](https://docs.gu1.ai/en/introduction.md): AI-powered risk analysis and compliance platform for financial institutions
- [Get entity monitoring status](https://docs.gu1.ai/en/monitoring/api-reference/get-entity-monitoring.md): GET /entities/{id}/monitoring — watchlist-style monitoring state per integration (e.g. Gueno sanctions).
- [Get entity monitoring history](https://docs.gu1.ai/en/monitoring/api-reference/get-entity-monitoring-history.md): GET /entities/{id}/monitoring/history — subscriptions and screening change timeline.
- [Enable or disable monitoring by entity and integration](https://docs.gu1.ai/en/monitoring/api-reference/patch-toggle-status-monitoring.md): PATCH /entities/toggle-status-monitoring — provider-code–extensible.
- [Entity monitoring](https://docs.gu1.ai/en/monitoring/overview.md): Watchlists and periodic screening per integration (e.g. Gueno global sanctions), separate from transaction monitoring.
- [Quickstart: KYB Risk Analysis in 5 Minutes](https://docs.gu1.ai/en/quickstart.md): Learn how to analyze company risk using gu1 API in under 5 minutes
- [How to Create and Manage API Keys](https://docs.gu1.ai/en/tutorials/manage-api-keys.md): Complete guide to generate, configure, and securely manage API keys in gu1
- [How to Switch Between Environments (Production and Sandbox)](https://docs.gu1.ai/en/tutorials/switch-environments.md): Learn to switch between production and sandbox environments to safely test configurations
- [Complete Company (KYB) Flow](https://docs.gu1.ai/en/use-cases/kyb/complete-flow.md): End-to-end guide for creating, enriching, and analyzing company entities with shareholder discovery
- [KYB Data Requirements](https://docs.gu1.ai/en/use-cases/kyb/data-requirements.md): Required and optional data fields for business verification
- [KYB Complete Example](https://docs.gu1.ai/en/use-cases/kyb/example.md): Full working implementation of business verification
- [KYB Overview](https://docs.gu1.ai/en/use-cases/kyb/overview.md): Know Your Business - Automated business verification and risk assessment
- [KYB Workflow](https://docs.gu1.ai/en/use-cases/kyb/workflow.md): Step-by-step process for automated business verification
- [Approve KYC Validation](https://docs.gu1.ai/en/use-cases/kyc/approve-validation.md): Manually approve a KYC validation
- [Biometric Check](https://docs.gu1.ai/en/use-cases/kyc/biometric.md): Validate a face image against previously approved KYC sessions
- [Cancel KYC Validation](https://docs.gu1.ai/en/use-cases/kyc/cancel-validation.md): Cancel a pending, in-progress, or in-review KYC validation
- [Check Verification Status](https://docs.gu1.ai/en/use-cases/kyc/check-status.md): Query KYC validation results and verification details
- [Client-Side Integration Guide](https://docs.gu1.ai/en/use-cases/kyc/client-integration.md): Complete guide for integrating KYC verification in mobile apps and web applications
- [Complete Person (KYC) Flow](https://docs.gu1.ai/en/use-cases/kyc/complete-flow.md): End-to-end guide for creating, enriching, and analyzing person entities with KYC validation
- [Create KYC Validation](https://docs.gu1.ai/en/use-cases/kyc/create-validation.md): Initiate a KYC verification session for a person entity
- [Get Current KYC Validation](https://docs.gu1.ai/en/use-cases/kyc/current-validation.md): Retrieve the current active KYC validation for an entity
- [Custom Configuration](https://docs.gu1.ai/en/use-cases/kyc/custom-configuration.md): Configurable parameters for the hosted onboarding page: branding, colors, and validation rules
- [Face Match (Document + Selfie)](https://docs.gu1.ai/en/use-cases/kyc/face-match.md): Verify that a selfie and a document photo belong to the same person via a single API call
- [Get Face Match images](https://docs.gu1.ai/en/use-cases/kyc/face-match-images.md): Download the document and selfie images for a Face Match verification
- [Get Face Match Verification](https://docs.gu1.ai/en/use-cases/kyc/get-face-match-verification.md): Retrieve a single Face Match audit record by ID
- [Get ID Verification (List & Single)](https://docs.gu1.ai/en/use-cases/kyc/get-id-verification-verification.md): List ID verification audit records or get one by ID
- [Get KYC Verification URL](https://docs.gu1.ai/en/use-cases/kyc/get-kyc-url.md): Retrieve the verification URL to share with your customer
- [Hosted Onboarding Page](https://docs.gu1.ai/en/use-cases/kyc/hosted-page.md): The quickest way to build optimized identity verification pages, hosted on Gu1
- [ID Verification (Document Front/Back)](https://docs.gu1.ai/en/use-cases/kyc/id-verification.md): Verify identity document (front and optional back), extract MRZ and data, get Approved or Declined in a single API call
- [Get ID Verification images](https://docs.gu1.ai/en/use-cases/kyc/id-verification-images.md): Download document front and back images for an ID Verification
- [List KYC Validations for Entity](https://docs.gu1.ai/en/use-cases/kyc/list-validations.md): Retrieve all KYC validation history for a specific entity
- [KYC API Overview](https://docs.gu1.ai/en/use-cases/kyc/overview.md): Identity verification for individual customers via API
- [Reject KYC Validation](https://docs.gu1.ai/en/use-cases/kyc/reject-validation.md): Manually reject a KYC validation
- [Sandbox mock data](https://docs.gu1.ai/en/use-cases/kyc/sandbox-mock-data.md): Test document numbers and expected outcomes for KYC in sandbox
- [Sync KYC Validation](https://docs.gu1.ai/en/use-cases/kyc/sync-validation.md): Manually synchronize KYC validation data with the provider
- [Get KYC validation media](https://docs.gu1.ai/en/use-cases/kyc/validation-media.md): Download document images, portrait, liveness video, and other assets stored for a session-based KYC validation
- [KYC Warning Risk Codes](https://docs.gu1.ai/en/use-cases/kyc/warning-risk-codes.md): Risk code strings for warnings in session-based KYC, ID Verification, Face Match, and Liveness
- [Webhook Integration](https://docs.gu1.ai/en/use-cases/kyc/webhook-integration.md): Receive real-time notifications when KYC verification status changes
- [AML Monitoring](https://docs.gu1.ai/en/use-cases/transaction-monitoring/aml-monitoring.md): Anti-money laundering compliance and suspicious activity detection
- [API Reference - Transaction Monitoring](https://docs.gu1.ai/en/use-cases/transaction-monitoring/api-reference.md): POST /transactions in monitoring context: currency conversion, payment methods, examples
- [Change Transaction Status](https://docs.gu1.ai/en/use-cases/transaction-monitoring/change-status-api.md): Update transaction status and trigger update rules automatically
- [Complete Transaction Monitoring Flow](https://docs.gu1.ai/en/use-cases/transaction-monitoring/complete-flow.md): End-to-end guide for creating, analyzing, and monitoring transactions with automatic risk scoring
- [Fraud Detection](https://docs.gu1.ai/en/use-cases/transaction-monitoring/fraud-detection.md): Real-time fraud detection patterns and rules for transaction monitoring
- [Merchant Monitoring](https://docs.gu1.ai/en/use-cases/transaction-monitoring/merchant-monitoring.md): Merchant supervision for acquirers, sub-acquirers, and payment processors
- [Transaction Monitoring](https://docs.gu1.ai/en/use-cases/transaction-monitoring/overview.md): Real-time fraud detection, AML compliance, and transaction analysis
- [Rules Configuration](https://docs.gu1.ai/en/use-cases/transaction-monitoring/rules-configuration.md): Complete guide for creating and configuring transaction monitoring rules
- [Webhook Configuration](https://docs.gu1.ai/en/webhooks/configuration.md): Step-by-step guide to configure webhooks in your Gu1 dashboard
- [Entity Webhook Events](https://docs.gu1.ai/en/webhooks/events/entity-events.md): Receive real-time notifications when entities are created, updated, or their status changes
- [KYC Webhook Events](https://docs.gu1.ai/en/webhooks/events/kyc-events.md): Receive real-time notifications when KYC verification status changes
- [Risk Analysis Webhook Events](https://docs.gu1.ai/en/webhooks/events/risk-analysis-events.md): Receive real-time notifications when a risk analysis (risk matrix execution) completes
- [Rule Webhook Events](https://docs.gu1.ai/en/webhooks/events/rule-events.md): Receive real-time notifications when compliance rules are triggered
- [Transaction Webhook Events](https://docs.gu1.ai/en/webhooks/events/transaction-events.md): Receive real-time notifications when transactions are created or updated
- [Webhooks Overview](https://docs.gu1.ai/en/webhooks/overview.md): Real-time notifications for all events in your Gu1 organization
- [Webhook Security](https://docs.gu1.ai/en/webhooks/security.md): Secure your webhook endpoints with signature verification and best practices
- [Actions](https://docs.gu1.ai/en/workflows/actions.md): Automation engine actions: IDs, behavior, minimum context, and what they write to event.data.
- [Building flows](https://docs.gu1.ai/en/workflows/building-flows.md): Graph vs steps mode, branching, fan-out, conditions, and validation when saving.
- [Context and standby](https://docs.gu1.ai/en/workflows/context-and-standby.md): Shared event.data, refresh on resume, standby limits, and KYC patterns.
- [Workflows & automations](https://docs.gu1.ai/en/workflows/overview.md): How gu1 workflows work—triggers, conditions, actions, standby, and creating flows in the product or via API.
- [Rules and workflows](https://docs.gu1.ai/en/workflows/rules-and-workflows.md): How AML rules relate to automations and the rule_triggered trigger.
- [Synergy](https://docs.gu1.ai/en/workflows/synergy.md): Which triggers allow which actions, and which actions may follow each other—same rules as the API and Workflow Builder.
- [Triggers](https://docs.gu1.ai/en/workflows/triggers.md): All workflow trigger types, optional filters (triggerConfig), and typical event context.