Skip to content

chore(spec): sync API spec 2026-11-01 - #19

Open
github-actions[bot] wants to merge 1 commit into
mainfrom
chore/spec-sync
Open

chore(spec): sync API spec 2026-11-01#19
github-actions[bot] wants to merge 1 commit into
mainfrom
chore/spec-sync

Conversation

@github-actions

@github-actions github-actions Bot commented Oct 30, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Automated sync of the upstream OpenAPI documents (docs/DESIGN.md section 3.1) by codegen/spec_sync.rb. Regenerated the SDK: 63 generated files changed. Generated code under lib/, sig/ and spec/generated/ comes from codegen/ and openapi/; never edit it by hand.

File URL Old SHA-256 New SHA-256
openapi/verification.json https://docs.didit.me/openapi-25.json 12b2fdb05572755d61b93791f6964b7d883ba7b20f7ea9b31543903b6edab8a9 c6707376c9bcdf636c1fd5452f61955c2c5ca304cce6a1ea8018d4c087fe8914
openapi/account.json https://docs.didit.me/openapi-auth.json ae1b5e07df822fe93cae27a9eaa0790948069352c9d98c87eecf7efd644c92cb 5b45b1896ef3107dd9a601c76d9ba35761bae5f04ac731b6c27876603903bf05

Breaking changes

  • sessions.retrieve_decision (GET /v3/session/{sessionId}/decision/): response 200 signatures[].confirmation.channel: can now be null
  • sessions.retrieve_decision (GET /v3/session/{sessionId}/decision/): response 200 registry_checks[].company.registry_data: can now be null
  • sessions.retrieve_decision (GET /v3/session/{sessionId}/decision/): response 200 registry_checks[].ownership_structure: can now be null
  • email.assess_risk (POST /v3/email/risk/): response 200 email.email_intelligence.reason_codes[]: type changed from string to object
  • kyb.select (POST /v3/kyb/select/): response 200 kyb_registry.registry_data: can now be null
  • kyb.list_shareholders (POST /v3/kyb/shareholders/): response 200 kyb_registry.registry_data: can now be null
  • kyb.list_ubos (POST /v3/kyb/ubo/): response 200 kyb_registry.registry_data: can now be null
  • phone.assess_risk (POST /v3/phone/risk/): response 200 phone.phone_intelligence.reason_codes[]: type changed from string to object
  • sessions.import_shared (POST /v3/session/import-shared/): response 201 signatures[].confirmation.channel: can now be null
  • sessions.import_shared (POST /v3/session/import-shared/): response 201 registry_checks[].company.registry_data: can now be null
  • sessions.import_shared (POST /v3/session/import-shared/): response 201 registry_checks[].ownership_structure: can now be null
  • sessions.signatures.validate (POST /v3/session/{sessionId}/signatures/{nodeId}/validate/): response 200 signatures[].confirmation.channel: can now be null

Operations

Added (14)

  • DELETE /v3/session/{sessionId}/kyb/parties/drafts/{draftId}/: sessions.delete_kyb_party_draft
  • GET /v3/organization/{organization_id}/application/{application_id}/analytics/today/: analytics.retrieve_today
  • GET /v3/session/{sessionId}/files-export/{exportId}/: sessions.get_files_export
  • GET /v3/session/{sessionId}/kyb/extracted-parties/: sessions.list_kyb_extracted_parties
  • GET /v3/session/{sessionId}/kyb/parties/drafts/: sessions.list_kyb_party_drafts
  • GET /v3/travel-rule/unmatched/: travel_rule.unmatched_deposits.list
  • PATCH /v3/session/{sessionId}/kyb/parties/drafts/{draftId}/: sessions.update_kyb_party_draft
  • POST /v3/id-verification/wallets/google-wallet/: id_wallets.start_google_wallet
  • POST /v3/id-verification/wallets/verifications/{request_id}/response/: id_wallets.submit_verification_response
  • POST /v3/session/{sessionId}/files-export/: sessions.export_files
  • POST /v3/session/{sessionId}/kyb/documents/: sessions.upload_kyb_documents
  • POST /v3/session/{sessionId}/kyb/parties/drafts/: sessions.create_kyb_party_draft
  • POST /v3/session/{sessionId}/kyb/parties/submit/: sessions.submit_kyb_parties
  • POST /v3/travel-rule/unmatched/{transaction_uuid}/match/: travel_rule.unmatched_deposits.match

Changed (370)

  • DELETE /v3/biometric-templates/{template_uuid}/ (biometric_templates.delete): documentation only
  • DELETE /v3/events/{event_uuid}/delete/ (monitoring_events.delete): documentation only
  • DELETE /v3/lists/{list_uuid}/ (lists.delete): documentation only
  • DELETE /v3/lists/{list_uuid}/entries/{entry_uuid}/ (lists.entries.delete): documentation only
  • DELETE /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/ (cases.blueprints.delete): documentation only
  • DELETE /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/draft/ (cases.blueprints.discard_draft): documentation only
  • DELETE /v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/draft/ (cases.routing_rules.discard_draft): documentation only
  • DELETE /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/ (cases.delete): documentation only
  • DELETE /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/links/{link_uuid}/ (cases.links.delete): documentation only
  • DELETE /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/{note_uuid}/ (cases.notes.delete): documentation only
  • DELETE /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/notes/{note_uuid}/ (networks.notes.delete): documentation only
  • DELETE /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/ (regulatory_reports.delete): documentation only
  • DELETE /v3/organization/{organization_id}/application/{application_id}/report-templates/{template_uuid}/ (report_templates.delete): documentation only
  • DELETE /v3/organization/{organization_id}/application/{application_id}/transactions/delete/ (transactions.batch_delete): documentation only
  • DELETE /v3/questionnaires/{questionnaire_uuid}/ (questionnaires.delete): documentation only
  • DELETE /v3/session/{sessionId}/delete/ (sessions.delete): documentation only
  • DELETE /v3/transactions/rules/install/ (transactions.rules.uninstall_library): documentation only
  • DELETE /v3/transactions/rules/{rule_uuid}/ (transactions.rules.delete): documentation only
  • DELETE /v3/travel-rule/counterparty-contacts/{contact_uuid}/ (travel_rule.counterparty_contacts.delete): documentation only
  • DELETE /v3/travel-rule/vasps/{vasp_id}/decision/ (travel_rule.clear_vasp_decision): documentation only
  • DELETE /v3/travel-rule/wallet-addresses/{entry_uuid}/ (travel_rule.wallet_addresses.delete): documentation only
  • DELETE /v3/webhook/destinations/{destination_uuid}/ (webhooks.destinations.delete): documentation only
  • DELETE /v3/workflows/{settings_uuid}/ (workflows.delete): documentation only
  • GET /v1/transactions/{transaction_id}/ (not exposed by the server SDKs): documentation only
  • GET /v3/aml-monitoring/jobs/{job_id}/ (aml_monitoring.retrieve_job): documentation only
  • GET /v3/aml/dataset-freshness/ (aml.retrieve_dataset_freshness): documentation only
  • GET /v3/billing/balance/ (billing.retrieve_balance): documentation only
  • GET /v3/biometric-templates/ (biometric_templates.list): documentation only
  • GET /v3/biometric-templates/count/ (biometric_templates.count): documentation only
  • GET /v3/biometric-templates/{template_uuid}/ (biometric_templates.retrieve): documentation only
  • GET /v3/blocklist/ (blocklist.list): documentation only
  • GET /v3/businesses/ (businesses.list): details changed (formats, limits, error responses or similar)
  • GET /v3/businesses/{vendor_data}/ (businesses.retrieve): documentation only
  • GET /v3/customization/ (customization.retrieve): documentation only
  • GET /v3/events/ (monitoring_events.list): documentation only
  • GET /v3/events/enrichment-metrics/ (monitoring_events.retrieve_enrichment_metrics): documentation only
  • GET /v3/events/subjects/{vendor_data}/ (monitoring_events.retrieve_subject_timeline): documentation only
  • GET /v3/events/{event_uuid}/ (monitoring_events.retrieve): documentation only
  • GET /v3/fraud/checks/{check_id}/ (fraud_checks.retrieve): documentation only
  • GET /v3/id-verification/wallets/ (id_wallets.list)
    • response 200 wallets[].interaction: enum value digital_credentials added
  • GET /v3/id-verification/wallets/verifications/{request_id}/ (id_wallets.retrieve_verification)
    • response 200 wallet_verification.interaction: enum value digital_credentials added
    • response 200 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 200 wallet_verification.next_action.digital_credentials: field added
  • GET /v3/import-jobs/ (sessions.imports.list_jobs): documentation only
  • GET /v3/import-jobs/active/ (sessions.imports.list_active_jobs): documentation only
  • GET /v3/investigator/activity/ (investigator.list_activity): documentation only
  • GET /v3/investigator/activity/export/ (investigator.export_activity): documentation only
  • GET /v3/investigator/dashboard/ (investigator.retrieve_dashboard): documentation only
  • GET /v3/investigator/guardrails/ (investigator.list_guardrails): documentation only
  • GET /v3/investigator/performance/ (investigator.retrieve_performance): documentation only
  • GET /v3/investigator/queue/ (investigator.list_queue): documentation only
  • GET /v3/investigator/runs/{run_id}/ (investigator.retrieve_run): documentation only
  • GET /v3/investigator/settings/ (investigator.retrieve_settings): documentation only
  • GET /v3/investigator/summary/ (investigator.retrieve_summary): documentation only
  • GET /v3/investigator/transactions/{transaction_id}/ (investigator.retrieve_transaction): documentation only
  • GET /v3/lists/ (lists.list): documentation only
  • GET /v3/lists/{list_uuid}/ (lists.retrieve): documentation only
  • GET /v3/lists/{list_uuid}/entries/ (lists.entries.list): documentation only
  • GET /v3/organization/bank-verification-pricing/ (pricing.bank_verification): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/analytics/ (analytics.retrieve): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/business-sessions/{business_session_id}/networks/ (business_sessions.list_networks): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/businesses/toggle-ongoing-monitoring/{job_id}/ (businesses.retrieve_session_ongoing_monitoring_job): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/businesses/{business_session_id}/pdf/ (businesses.generate_session_pdf): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/businesses/{vendor_business_uuid}/networks/ (businesses.list_networks): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/ (cases.list): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/ (cases.blueprints.list): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/presets/ (cases.blueprints.list_presets): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/ (cases.blueprints.retrieve): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/draft/ (cases.blueprints.retrieve_draft): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/history/ (cases.blueprints.list_history): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/reviewers/ (cases.list_reviewers): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/ (cases.routing_rules.list): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/ (cases.routing_rules.retrieve): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/draft/ (cases.routing_rules.retrieve_draft): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/history/ (cases.routing_rules.list_history): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/statistics/ (cases.retrieve_statistics): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/teams/ (cases.teams.list): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/teams/{record_uuid}/ (cases.teams.retrieve): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/ (cases.retrieve): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/action-receipts/ (cases.list_action_receipts): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/aml/ (cases.list_aml_hits)
    • response 200 [].hits[].datasets[]: enum value Other Lists added
    • response 200 [].warnings[].feature: enum values GEOLOCATION, SIGNATURE added
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/checklist/ (cases.checklist.list): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/events/ (cases.list_events): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/links/ (cases.links.list): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/ (cases.notes.list): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/presign/ (cases.notes.retrieve_attachment_url): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/print/ (cases.print): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/ (cases.regulatory_reports.list): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/ (cases.requests.list): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/options/ (cases.requests.retrieve_options): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/{request_uuid}/attachment/ (cases.requests.retrieve_attachment): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/networks/ (networks.list): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/ (networks.retrieve): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/graph/ (networks.retrieve_graph): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/map/ (networks.retrieve_map): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/members/ (networks.list_members): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/notes/ (networks.notes.list): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/report/ (networks.download_report): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/signals/ (networks.list_signals): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/timeline/ (networks.retrieve_timeline): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/ (regulatory_reports.list): documentation only
  • GET /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/ (regulatory_reports.retrieve): documentation only
  • ... and 270 more (see the workflow log for the full summary)

Schemas

  • ApplicationAnalyticsToday added (verification.json)
  • BiometricRetention added (verification.json)
  • DigitalIdWalletApiGoogleWalletWalletVerificationStartCountryEnum added (verification.json)
  • DigitalIdWalletApiGoogleWalletWalletVerificationStartRequest added (verification.json)
  • DigitalIdWalletApiWalletDigitalCredentialResponseRequest added (verification.json)
  • DigitalIdWalletApiWalletDigitalCredentialsRequest added (verification.json)
  • GeolocationAttempt added (verification.json)
  • GeolocationCheck added (verification.json)
  • KYBOwnershipStructure added (verification.json)
  • KYBOwnershipStructureOwner added (verification.json)
  • KYBRegistryData added (verification.json)
  • KYBRegistryGroupCompany added (verification.json)
  • KYBRegistryLiteEnrichment added (verification.json)
  • KYBRegistrySectionError added (verification.json)
  • KYBRegistrySource added (verification.json)
  • KYBRegistryUboResolution added (verification.json)
  • SessionFilesExport added (verification.json)
  • TransactionRuleSuggestionsCreatedEvent added (verification.json)
  • TravelRuleManualMatchRequest added (verification.json)
  • TravelRuleManualMatchResponse added (verification.json)
  • AMLScreening changed (verification.json)
  • AMLScreeningRun changed (verification.json)
  • DigitalIdWalletApiInteractionEnum changed (verification.json)
  • DigitalIdWalletApiWalletNextAction changed (verification.json)
  • DigitalIdWalletApiWalletNextActionTypeEnum changed (verification.json)
  • EmailIntelligence changed (verification.json)
  • EmailVerificationCheckResponse changed (verification.json)
  • KYBRegistryCandidateRequest changed (verification.json)
  • PhoneIntelligence changed (verification.json)
  • PhoneVerificationCheckResponse changed (verification.json)
  • SessionDecision changed (verification.json)
  • SessionWebhookEventData changed (verification.json), documentation only
  • SignatureResult changed (verification.json)
  • SimpleWorkflowFeature changed (verification.json), documentation only
  • TransactionDetail changed (verification.json), documentation only
  • TransactionRuleCondition changed (verification.json), documentation only
  • UserSessionListItem changed (verification.json)
  • WebhookConfig changed (verification.json)
  • WebhookEvent changed (verification.json)
  • WebhookEventPayload changed (verification.json)
  • WorkflowDetail changed (verification.json)

SDK naming

No overlay entry changed.

Deprecations

No deprecation was added or expired.

Checks

  • bundle exec rake generate:check
  • bundle exec rake spec
  • bundle exec rake codegen:spec
  • bundle exec rake rubocop
  • bundle exec steep check

Published by spec sync run 41282139815.

BREAKING CHANGE: the API spec sync changes the SDK surface.

  • sessions.retrieve_decision (GET /v3/session/{sessionId}/decision/): response 200 signatures[].confirmation.channel: can now be null
  • sessions.retrieve_decision (GET /v3/session/{sessionId}/decision/): response 200 registry_checks[].company.registry_data: can now be null
  • sessions.retrieve_decision (GET /v3/session/{sessionId}/decision/): response 200 registry_checks[].ownership_structure: can now be null
  • email.assess_risk (POST /v3/email/risk/): response 200 email.email_intelligence.reason_codes[]: type changed from string to object
  • kyb.select (POST /v3/kyb/select/): response 200 kyb_registry.registry_data: can now be null
  • kyb.list_shareholders (POST /v3/kyb/shareholders/): response 200 kyb_registry.registry_data: can now be null
  • kyb.list_ubos (POST /v3/kyb/ubo/): response 200 kyb_registry.registry_data: can now be null
  • phone.assess_risk (POST /v3/phone/risk/): response 200 phone.phone_intelligence.reason_codes[]: type changed from string to object
  • sessions.import_shared (POST /v3/session/import-shared/): response 201 signatures[].confirmation.channel: can now be null
  • sessions.import_shared (POST /v3/session/import-shared/): response 201 registry_checks[].company.registry_data: can now be null
  • sessions.import_shared (POST /v3/session/import-shared/): response 201 registry_checks[].ownership_structure: can now be null
  • sessions.signatures.validate (POST /v3/session/{sessionId}/signatures/{nodeId}/validate/): response 200 signatures[].confirmation.channel: can now be null

@github-actions
chore(spec): sync API spec 2026-11-01
50fd45f 
Synced openapi/verification.json and openapi/account.json from the published API contract (docs/DESIGN.md section 3.1).
Operations: 14 added, 0 removed, 0 renamed, 0 moved, 370 changed.
Regenerated the SDK.

BREAKING CHANGE: the API spec sync changes the SDK surface.
- `sessions.retrieve_decision` (`GET /v3/session/{sessionId}/decision/`): response 200 `signatures[].confirmation.channel`: can now be null
- `sessions.retrieve_decision` (`GET /v3/session/{sessionId}/decision/`): response 200 `registry_checks[].company.registry_data`: can now be null
- `sessions.retrieve_decision` (`GET /v3/session/{sessionId}/decision/`): response 200 `registry_checks[].ownership_structure`: can now be null
- `email.assess_risk` (`POST /v3/email/risk/`): response 200 `email.email_intelligence.reason_codes[]`: type changed from string to object
- `kyb.select` (`POST /v3/kyb/select/`): response 200 `kyb_registry.registry_data`: can now be null
- `kyb.list_shareholders` (`POST /v3/kyb/shareholders/`): response 200 `kyb_registry.registry_data`: can now be null
- `kyb.list_ubos` (`POST /v3/kyb/ubo/`): response 200 `kyb_registry.registry_data`: can now be null
- `phone.assess_risk` (`POST /v3/phone/risk/`): response 200 `phone.phone_intelligence.reason_codes[]`: type changed from string to object
- `sessions.import_shared` (`POST /v3/session/import-shared/`): response 201 `signatures[].confirmation.channel`: can now be null
- `sessions.import_shared` (`POST /v3/session/import-shared/`): response 201 `registry_checks[].company.registry_data`: can now be null
- `sessions.import_shared` (`POST /v3/session/import-shared/`): response 201 `registry_checks[].ownership_structure`: can now be null
- `sessions.signatures.validate` (`POST /v3/session/{sessionId}/signatures/{nodeId}/validate/`): response 200 `signatures[].confirmation.channel`: can now be null
@github-actions github-actions Bot changed the title chore(spec): sync API spec 2026-10-30 chore(spec): sync API spec 2026-11-01 Nov 1, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

0 participants