Bulk automatic entity import β child enrichments & monitoring scope
POST /batch-import/import/entities and JSON bulk automatic import accept two optional fields (automatic mode, depth > 0):childEnrichmentPolicy:all_active(default),by_root_type, orbasic_only.by_root_type: company rows run all active enrichments on shareholders exceptglobal_gueno_sanctions_enrichment; person rows create related entities with basic data only from the root provider snapshot.
monitoringApplyToRelationships: whenfalse,monitoringapplies to main entities only (no watchlist on children). Defaulttruewhendepth> 0 if omitted.
Marketplace enrichment β structured errors
POST /integration-execution/marketplace/enrichment now returns richer per-integration error objects: optional category, retryable, and statusCode alongside code and message. Codes distinguish configuration issues (integration not enabled), timeouts, provider HTTP failures, and validation errors.Automatic / bulk entity creation β tax ID strictness
taxId on automatic and bulk creation must be only the fiscal identifier. Values merged with spreadsheet columns (e.g. CNPJ plus business segment text) are rejected with INVALID_TAX_ID.Transactions β optional exchangeRate fallback
POST /transactions and batch create accept optional exchangeRate on each transaction. Omitting it keeps the previous behavior (automatic conversion via the currency service).Used only when automatic conversion is unavailable. Semantics: base-currency units per 1 unit of currency; normalized base amount = amount Γ exchangeRate. Sets rateSource: client-provided.Non-convertible today (no automatic rate): WLD (Worldcoin), ETH (Ethereum). Send exchangeRate for a normalized base-currency amount and FX-dependent rules.See Create Transaction β Currency conversion.POST /entities/{entityId}/refresh β unified scope and safe field sync
New optional body fields (all backward compatible when omitted):refreshScope:basic_data|all_active|selected(+providerCodeswhenselected).preserveName:truekeeps the current display name; omitted = legacy sync from normalizedfullName.preserveEntityData: only withrefreshScope: "basic_data"βtruegap-fillsentityData,falsereplaces; omitted = do not touch profile.
basic_data always runs root-only (no shareholders), regardless of depth.See Refresh Entity. Existing Risk Matrix / integration payloads without these fields behave unchanged.GUENO_CROSS_ENTITY_DUPLICATED warning
When Gu1 resolves provider duplicate session/face references to another entity in the same organization (metadata.kycCrossEntityDuplicates.matches):- Appends warning
GUENO_CROSS_ENTITY_DUPLICATEDto session validationwarnings. - If the provider mapped
approved, Gu1 sets status toin_review(metadata.guenoCrossEntityDuplicateEscalation). - Non-omittable: cannot be sent in
omitWarnings(400) and blocks omit auto-approve.
omitWarnings.Gu1 Biometric (POST /api/kyc/biometric and /api/kyc/biometric/sessions)
Re-authentication after approved KYC: image upload check or hosted UI session (sessionUrl, iframeAllow, hostedSessionId, optional webhookUrl, org webhooks biometric.session_*, Gu1 status / rejectionCode). Marketplace product global_gueno_biometric_kyc. See Biometric verification, Biometric session, and Biometric webhook events.decision always includes array + object feature pairs
On persist (sync, webhook ingest, manual ingest), Gu1 normalizes decision so integrators can read either legacy singular keys or array keys interchangeably:id_verificationβid_verifications[0]livenessβliveness_checks[0]face_matchβface_matches[0]aml_screeningβaml_screenings[0]ip_analysisβip_analyses[0]
array[0] wins and the singular object is synchronized. Applies to GET validation responses and KYC webhooks (payload.decision).Mintlify examples updated with complete decision payloads (no vendor branding; media as kyc/... keys). See KYC webhook events.Per-run rules engine config on POST /entities/{entityId}/analyze
New optional body object rulesEngineConfig (all fields default false):partialCoverage: with multiple assigned matrices, data coverage is validated per matrix; matrices without data are skipped (matricesSkippedForCoverage/warningson partial success).omitCoverage: skip data coverage gates entirely (main entity + shareholders). Precedence overpartialCoveragewhen both are true.
422 INCOMPLETE_DATA_COVERAGE).See Analyze Entity and Execute Risk Matrix.ejemplar in extractedData
Argentine DNI verifications can include extractedData.ejemplar (AβD) on KYC validations and ID Verification audit records (GET, sync, webhooks).With doubleCheckRenaper: true, comparisonResults.ejemplar compares OCR vs RENAPER; mismatch adds RENAPER_EJEMPLAR_NOT_MATCH to warnings.See extractedData fields and RENAPER double-check.RENAPER double-check on KYC validations
WithdoubleCheckRenaper: true, metadata.responseDoubleChecks.renaper includes comparisonResults, renaperBiometric (when applicable), and RENAPER codes in warnings (e.g. RENAPER_TRAMITE_ID_NOT_MATCH, RENAPER_EXPIRY_NOT_MATCH) without replacing OCR KYC verification warnings.Enforcement (auto-reject): only when OCR KYC verification returns status approved. On in_review and rejected the check is informational and stores registry data. POST /api/kyc/validations/{id}/approve from in_review does not re-run RENAPER.See Create KYC validation and Approve validation.Marketplace *_check product removed
- Removed: all
*_checkprovider codes,POST /integration-execution/marketplace/check, rules triggers/actionscheck_completed/execute_check, and RBAC permissionschecks:read/checks:execute. - Use instead: matching
*_enrichmentcodes with Execute enrichment. - Backward compat: legacy create/import payloads with
checks,executeAllActiveChecks, or*_checkinsideautoExecuteIntegrations.enrichmentsare silently ignored at parse time.
Stable batch failure codes and JSON endpoints
- Row failures now include stable
code+message(catalog: Failure codes). CSV adds acodecolumn (external_id,code,error/row_key,code,error/ entityβ¦,code,error_message). - New JSON endpoints:
GET /batch-import/transaction-jobs/{jobId}/failures,GET /batch-import/user-event-jobs/{jobId}/failures,GET /batch-import/entity-jobs/{jobId}/failuresβ includefailures[], optionaljobFailurefor whole-job errors, entityskips[],truncated/failuresTotal(max 500 stored). - CSV download: same routes with
.csvsuffix (failures.csv). - Legacy rows with only free-text
errorare normalized on read when possible.
Assign risk matrices on entity update
PATCH /entities/{id}(andPATCH /entities/by-external-id/{externalId},PATCH /entities/by-tax-id/{taxId}): documentriskMatrixIds(string[]) andriskMatrixId(string | string[] | null) β same normalization as create. Assigns matrices on the entity; does not run the rules engine (use Analyze entity or lifecycle triggers).- Mintlify updated in
/en/,/es/,/pt/on Update entity and Update by external ID.
configRulesExecution on create transaction
POST /transactions: optional body objectconfigRulesExecutionwithnotifications(boolean). Whenfalse, gu1 skips in-app notifications from rules evaluation (risk matrix / status).createAlertactions and investigations are unchanged.- Default: omitting the object keeps prior behavior for most orgs (
notificationseffectivelytrue). Paytime prod (3bc1f621-27d4-423e-9d64-86680bec2388) defaults tonotifications: falsewhen omitted. - Legacy KYT
POST /legacy/kyt/verifyTransaction: same field on the Gu2 body; Paytime prod defaultnotifications: falsewhen omitted (normalized before create). - Applies to sync and async rules (
asyncRules).
/es/ and /pt/.POST /transactions and batch create β linked counterparty fields
When origin or destination is linked to a person/company (originEntityId / auto-link by external or tax id), gu1 always overwrites denormalized columns from the entity row before insert:originTaxId/destinationTaxIdβentities.tax_idoriginExternalId/destinationExternalIdβentities.external_id
/es/ and /pt/.POST /events/user β isNewDevice honors integrator value
- If you send
isNewDevice: trueorfalse, gu1 persists exactly that value (no server override). - If you omit the field, gu1 infers it when
deviceId+deviceDetailsare present (device registry;truewhen the device is new orfirstSeenAtis within the last 5 minutes); otherwisefalse.
/es/ and /pt/.Platform CSV: attributes.* and entityData.*
- Dotted headers (same approach as native transaction CSV):
attributes.segment_tag,entityData.income,entityData.tradeName. entityData.<field>withoutperson/companyuses the rowtypebucket.- Unprefixed columns (
segment_tag) still map toattributes(backward compatible). - See Import entities (CSV).
Import limits documented (en / es / pt)
- Bulk imports overview: matrix of max files per request, max rows by plan, and manual vs automatic entity import.
- Per-endpoint pages now include limits: Import entities (CSV), Import transactions, Import user events.
- CSV entity import uses plan limits (4kβ100k). Runtime caps:
GET /individual-organization/batch-upload-enabled.
/es/ and /pt/ docs.Bulk entity import countries (manual vs automatic)
- Manual (
manual): any valid platform ISO2 (batch or per-rowcountry/country_code). - Automatic (
automatic): AR, BR, and CL (basic data by tax ID, including Chile ruts.info / BaseAPI enrichments). - Applies to
POST /batch-import/import/entities(platform CSV and custom CSV withmappingId).
POST /batch-import/import/entities β manual mode enrichments
- Manual multipart now matches the dashboard Manual hub mode: optional
autoExecuteIntegrations,monitoring, and risk matrices β without the country basic-data pipeline (Nosis/CPF). - CSV-only upload (no
autoExecuteIntegrations) still creates minimal entities with no enrichments. - Per-row CSV enrichment columns apply in manual mode;
depth/ shareholders remain automatic-only.
POST /batch-import/import/entities β manual default
- Omitting
entityImportModeβmanual(minimal entity; enrichments only when explicitly requested). - Automatic with
entityImportMode=automatic(+ optionalautoExecuteIntegrations,depth, etc.). - Manual mode requires
suggested_nameon every row (400if missing). - Template
bulk-entities-template.csv: documented columns; demo row without active enrichments. 202response includes effectiveimportMode.
POST /batch-import/import/entities β platform format
mappingIdoptional for platform CSV headers. Import default:manual(see next changelog entry on this date).
asyncRules on create transaction
POST /transactions: optional query or body flagasyncRules(defaultfalse). WhentrueandexecuteRulesis notfalse, the transaction is created in the same request but rules run in the background via a job queue. The HTTP response returns immediately with emptyrulesHit/rulesNoHit, plusasyncRules: trueandrulesEvaluationStatus: "queued".- Default unchanged: omitting
asyncRuleskeeps synchronous rules execution and a fullrulesExecutionSummaryβ existing clients behave exactly as before. - Legacy KYT
POST /legacy/kyt/verifyTransaction: same flag via query or Gu2 body field. Paytime prod (3bc1f621-27d4-423e-9d64-86680bec2388) defaults to async when the flag is omitted; useasyncRules=falseto force synchronous rules for a single request. - Not on batch endpoints. If Redis/queue is unavailable, API may return 503
ASYNC_RULES_QUEUE_UNAVAILABLE(transaction may already exist β check response body before retry).
RENAPER double-check on standalone KYC endpoints
POST /api/kyc/face-match: optionaldoubleCheckRenaper(body or?doubleCheckRenaper=true). After Gu1 face match approves, runs RENAPER biometric (validate-dniwith selfie) and data (DNI + trΓ‘mite). RequiresdocumentNumber,gender, andpersonalNumber(or entity fallback for DNI/gender). Response addsresponseDoubleChecks.renaper(including nestedrenaperBiometricwhen biometric check runs).POST /api/kyc/id-verification: same flag; after OCR approval runs RENAPER data check only (fields fromextractedData). Failed checks setstatustodeclinedand add RENAPER codes towarnings.- Org RENAPER credentials required (same as session KYC). Use HTTP timeout β₯ 60s for face-match with double-check.
KYT β separate status-change vs field-update triggers
PATCH β¦/changeStatusnow runs rules/matrices with triggerstatus_changed(trigger_transaction_status_changed), notupdated.PATCH /transactions/{id}(metadata, deviceDetails, channel, reason) withexecuteRules=truestill usesupdated(trigger_transaction_updated).- Migration: reconfigure rules that must run on status transitions to the new trigger (Rule Builder: On transaction status change; matrices:
transaction_status_changed). Rules with onlyupdated/ Transaction updated no longer run on changeStatus.
Partial transaction update
PATCH /transactions/{id}andPATCH /transactions/external/{externalId}: updatemetadata(shallow merge β omitted keys are preserved),deviceDetails(shallow merge intodevice_details),channel(nullable), and/orreason(enum). Requirestransactions:edit.- Query
executeRules=trueoptionally re-runs KYT rules with triggerupdated(trigger_transaction_updated) β not status-change rules. - Emits audit
transaction_updatedand webhooktransaction.updatedwith achangesmap (includesdeviceDetailswhen patched).
User events β has-events by external ID or tax ID
GET /events/user/entity/has-events(new): boolean check without the internal entity UUID. Query params:entity_id,entity_external_id, ortax_id(at least one required). Lookup priority:entity_idβentity_external_idβtax_id; tax IDs are matched with normalization (non-alphanumeric stripped).- Response still includes resolved
entityIdso you can call List by Entity whenhasEventsis true. GET /events/user/entity/{entityId}/has-eventsremains supported (unchanged contract).
Session KYC β Device & IP analysis warnings
GET /api/kyc/validations/:id(and sync/webhook paths): the top-levelwarningsarray now mergesriskcodes fromdecision.ip_analyses[].warnings[](and legacydecision.ip_analysis.warnings), alongside ID verification, liveness, face match, and AML.- Eight provider codes are supported (e.g.
PRIVATE_NETWORK_DETECTED,DUPLICATED_DEVICE_FINGERPRINT,IP_ADDRESS_IN_BLOCKLIST). See KYC Warning Risk Codes β Device & IP Analysis. - The same codes are valid in
omitWarningsonPOST /api/kyc/validationswhen auto-approvingin_reviewsessions.
warnings until the next sync; re-fetch or sync to backfill IP analysis codes on older rows.ID Verification β richer extractedData
POST /api/kyc/id-verificationand audit list/get now persist and return a broaderextractedDataobject: identity fields (personalNumber,taxNumber,placeOfBirth, β¦),providerStatus,warningMeta(e.g. duplicate session IDs), quality scores,extraFields,mrz,parsedAddress,barcodeswhen returned by the Gu1 ID Verification service.warningsremains a string array of risk codes for i18n; usewarningMetainsideextractedDatafor structured duplicate-session metadata.- External document image URLs and base64 are not returned; images you uploaded are available via ID Verification images.
debugProviderResponsemay appear only in non-production Gu1 API environments (sanitized verification payload, no images).
operational hours per entity (global)
- Entities: Optional root field
operationalHours(timezoneenum +weeklyslots). Stored inentities.operational_hours. Documented on Create entity and related entity endpoints. - Transactions:
transaction_time_zoneenum extended (Brazil zones). OptionaltimeZoneis independent of entityoperationalHours.transactedAt: stored as UTC; ISO withZunchanged for existing clients; optional local datetime +timeZoneconverts to UTC when both are sent. - Rules: New operators
outside_entity_operational_hoursandinside_entity_operational_hoursontransactedAtwith valueoriginordestination. RequiresoperationalHourson the linked entity.
timeZone on transactions
- Database: New nullable column
time_zoneontransactionswith enum typetransaction_time_zone(IANA values such asAmerica/Argentina/Buenos_Aires,UTC, etc.). Existing rows remainnull. - API: Optional
timeZoneonPOST /transactionsand batch create; returned onGET /transactions/{id}andGET /transactions/external/{externalId}asstring | null.
validateExistingEntity (transaction create)
POST /transactions: optionalvalidateExistingEntity(defaultfalse). Whentrue, every origin/destination identifier you send must resolve to an existing person/company; otherwise 400INVALID_ENTITY_REFERENCESand no row is created.- Batch endpoints: default remains
true. UsevalidateExistingEntity: falsefor permissive bulk import. - Legacy KYT
POST /legacy/kyt/verifyTransaction: same field in the Gu2 body.
excludeEnrichments on entity creation
autoExecuteIntegrations and autoExecuteIntegrationsShareholders (manual POST /entities, POST /entities/automatic, bulk import, materialize) now accept excludeEnrichments: an array of provider codes removed from the final enrichment set after merge (including when executeAllActiveEnrichments is true).executeAllActiveChecks and checks are no longer part of the public contract for these objects. Legacy payloads that still send them are ignored at parse time.See Create entity (automatic) and Create entity.New: Hosted Onboarding Page Documentation
Complete documentation for the Hosted Onboarding Page - the quickest way to implement KYC verification without code.Whatβs New
Hosted Page Documentation:- β Complete customization parameters guide (branding, colors, layout)
- β Validation rules configuration (age verification, capture methods, duplicate detection)
- β Document validation rules (QR/barcode, MRZ, expiration dates, liveness)
- β Step-by-step integration guide with code examples
- β Visual flow diagram showing the complete process
- β Security best practices for session management
- β Mobile-responsive design confirmation
- π± Mobile-responsive design for all devices
- π¨ Full customization of colors, branding, and layout
- π Comprehensive security guidelines
- π Visual sequence diagrams for clarity
- π Support channel information for configuration changes
Languages
All documentation available in:- πΊπΈ English
- πͺπΈ EspaΓ±ol
- π§π· PortuguΓͺs
Impact
- Faster implementation for no-code solutions
- Clear guidance on customization options
- Enhanced security awareness
- Better understanding of the hosted page workflow
KYC Pages Refinement Based on Client Feedback
Major enhancement to KYC documentation based on 14 questions from client feedback.Whatβs New
Complete Flow Documentation:- β Added comprehensive comparison table: Automatic vs Manual creation
- β Complete Risk Matrix configuration guide with dashboard instructions
- β Clarified shareholders feature (KYB only, not KYC)
- β Provider codes reference with usage examples
- β Detailed credit management section with costs and workflows
- β Webhooks vs manual polling explanation
- β Full KYC vs Individual Verifications comparison table
- β Comprehensive face matching security warning for banks/fintech
- β Enhanced API endpoints table with use cases
- β Complete sequence diagram showing full flow
- β Sandbox vs Production clarification
- β Duplicate entity handling with code examples
- β Expanded integrationCode documentation
- β Marked optional fields with examples (attributes, entityData)
- β Minimal vs full entity creation examples
Languages
All improvements available in:- πΊπΈ English
- πͺπΈ EspaΓ±ol
- π§π· PortuguΓͺs
Impact
- 14 client questions answered inline
- 12 documentation files updated
- 0 broken links
- Improved developer onboarding experience
Enhanced Multi-language Documentation
Improved documentation structure with complete Spanish and Portuguese translations.Changes
- Complete translation coverage for KYC, KYB, and Transaction Monitoring
- Consistent terminology across all languages
- Language-specific examples (CPF for Brazil, DNI for Spain, etc.)
Available Languages
- English (EN) - Primary
- Spanish (ES) - Complete
- Portuguese (PT) - Complete
gu1 Documentation Launch
Initial release of comprehensive API documentation.Core Features
- Complete API reference for all endpoints
- Use case guides (KYC, KYB, Transaction Monitoring)
- Webhook integration guides
- Interactive tutorials
- Multi-language support
Components
- Person entities API
- Company entities API
- KYC validation workflows
- Transaction monitoring
- Rules engine
- Risk matrices
- Alerts and investigations