Skip to content

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

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

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 •

Copy link
Copy Markdown
Contributor

Automated sync of the upstream OpenAPI documents (docs/DESIGN.md section 3.1).

File Upstream SHA-256
openapi/verification.json https://docs.didit.me/openapi-25.json 12b2fdb05572 -> c6707376c9bc
openapi/account.json https://docs.didit.me/openapi-auth.json ae1b5e07df82 -> 5b45b1896ef3

Breaking changes

  • email.assess_risk() (POST /v3/email/risk/): response 200 email.email_intelligence.reason_codes[]: type changed from string to object
  • phone.assess_risk() (POST /v3/phone/risk/): response 200 phone.phone_intelligence.reason_codes[]: type changed from string to object

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 (125)

  • DELETE /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/ (regulatory_reports.delete): request body (documentation only)
  • GET /v1/transactions/{transaction_id}/: response 200 (documentation only)
  • GET /v3/businesses/ (businesses.list): parameters
  • GET /v3/id-verification/wallets/ (id_wallets.list): response 200
    • response 200 wallets[].interaction: enum value digital_credentials added
  • GET /v3/id-verification/wallets/verifications/{request_id}/ (id_wallets.retrieve_verification): response 200
    • 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/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/aml/ (cases.list_aml_hits): response 200
    • response 200 [].hits[].datasets[]: enum value Other Lists added
    • response 200 [].warnings[].feature: enum value GEOLOCATION, SIGNATURE added
  • GET /v3/session/{sessionId}/aml-screening-history/ (sessions.list_aml_screening_history): parameters, response 200
    • query parameter month: added
    • response 200 results[].run_id: field added
    • response 200 results[].new_hits: field added
    • response 200 results[].entities_screened: field added
  • GET /v3/session/{sessionId}/aml-screening-history/export/ (sessions.export_aml_screening_history): parameters, response 200
    • query parameter month: added
  • GET /v3/session/{sessionId}/decision/ (sessions.retrieve_decision): response 200
    • response 200 id_verifications[].warnings[].feature: enum value GEOLOCATION, SIGNATURE added
    • response 200 id_verifications[].region: field added
    • response 200 id_verifications[].extracted_data: field added
    • response 200 id_verifications[].barcodes: field added
    • response 200 nfc_verifications[].warnings[].feature: enum value GEOLOCATION, SIGNATURE added
    • response 200 liveness_checks[].warnings[].feature: enum value GEOLOCATION, SIGNATURE added
    • response 200 face_matches[].warnings[].feature: enum value GEOLOCATION, SIGNATURE added
    • response 200 face_matches[].face_coverage: field added
    • response 200 phone_verifications[].warnings[].feature: enum value GEOLOCATION, SIGNATURE added
    • response 200 phone_verifications[].phone_intelligence: field added
    • response 200 phone_verifications[].phone_social: field added
    • response 200 email_verifications[].warnings[].feature: enum value GEOLOCATION, SIGNATURE added
    • response 200 email_verifications[].email_intelligence: field added
    • response 200 email_verifications[].email_social: field added
    • response 200 poa_verifications[].warnings[].feature: enum value GEOLOCATION, SIGNATURE added
    • response 200 signatures[].level: enum value simple added
    • response 200 signatures[].format: enum value pdf added
    • response 200 aml_screenings[].hits[].datasets[]: enum value Other Lists added
    • response 200 aml_screenings[].warnings[].feature: enum value GEOLOCATION, SIGNATURE added
    • response 200 ip_analyses[].warnings[].feature: enum value GEOLOCATION, SIGNATURE added
  • GET /v3/session/{sessionId}/signatures/{nodeId}/documents/{documentId}/file/ (sessions.signatures.download_document): parameters (documentation only)
  • GET /v3/session/{sessionId}/signatures/{nodeId}/evidence/ (sessions.signatures.download_evidence): parameters (documentation only)
  • GET /v3/session/{sessionId}/signatures/{nodeId}/fields/{fieldId}/image/ (sessions.signatures.download_field_image): parameters (documentation only)
  • GET /v3/session/{sessionId}/webhook/{webhook_uuid} (sessions.webhooks.retrieve): response 200
    • response 200 webhook_type: enum value transaction_rule_suggestions.created added
  • GET /v3/session/{sessionId}/webhooks/ (sessions.webhooks.list): response 200
    • response 200 [].webhook_type: enum value transaction_rule_suggestions.created added
  • GET /v3/sessions/ (sessions.list): parameters, response 200
    • query parameter tags: added
    • query parameter decided_from: added
    • query parameter decided_to: added
    • response 200 results[].features[].feature: enum value GEOLOCATION added
    • response 200 results[].assignee: field added
    • response 200 results[].waiting_since: field added
    • response 200 results[].sla_due_at: field added
    • response 200 results[].top_warnings: field added
    • response 200 results[].warnings_count: field added
  • GET /v3/transactions/ (transactions.list): parameters
    • query parameter assignee: added
  • GET /v3/transactions/rules/ (transactions.rules.list): response 200 (documentation only)
  • GET /v3/transactions/rules/library/ (transactions.rules.list_library): response 200 (documentation only)
  • GET /v3/transactions/rules/{rule_uuid}/ (transactions.rules.retrieve): response 200 (documentation only)
  • GET /v3/transactions/{transaction_id}/ (transactions.retrieve): response 200 (documentation only)
  • GET /v3/users/ (users.list): parameters
  • GET /v3/webhook/ (webhooks.retrieve_config): response 200
    • response 200 available_events[].value: enum value transaction_rule_suggestions.created added
    • response 200 allowed_domains: field added
  • GET /v3/webhook/destinations/ (webhooks.destinations.list): response 200
    • response 200 [].subscribed_events[]: enum value transaction_rule_suggestions.created added
  • GET /v3/webhook/destinations/{destination_uuid}/ (webhooks.destinations.retrieve): response 200
    • response 200 subscribed_events[]: enum value transaction_rule_suggestions.created added
  • GET /v3/webhook/destinations/{destination_uuid}/deliveries/ (webhooks.destinations.list_deliveries): response 200
    • response 200 results[].webhook_type: enum value transaction_rule_suggestions.created added
  • GET /v3/webhook/destinations/{destination_uuid}/deliveries/{delivery_uuid}/ (webhooks.destinations.retrieve_delivery): response 200
    • response 200 webhook_type: enum value transaction_rule_suggestions.created added
  • GET /v3/workflows/{settings_uuid}/ (workflows.retrieve): response 200
    • response 200 signature_availability: field added
  • PATCH /v3/investigator/settings/ (investigator.update_settings): request body (documentation only)
  • PATCH /v3/organization/{organization_id}/application/{application_id}/businesses/toggle-ongoing-monitoring/ (businesses.set_session_ongoing_monitoring): request body (documentation only)
  • PATCH /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/ (cases.blueprints.update): request body (documentation only)
  • PATCH /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/checklist/{item_uuid}/ (cases.checklist.toggle_item): request body (documentation only)
  • PATCH /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/{note_uuid}/ (cases.notes.update): request body (documentation only)
  • PATCH /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/ (regulatory_reports.update): request body (documentation only)
  • PATCH /v3/organization/{organization_id}/application/{application_id}/report-templates/{template_uuid}/ (report_templates.update): request body (documentation only)
  • PATCH /v3/organization/{organization_id}/application/{application_id}/vendor-businesses/toggle-ongoing-monitoring/ (businesses.set_ongoing_monitoring): request body (documentation only)
  • PATCH /v3/organization/{organization_id}/application/{application_id}/vendor-users/toggle-ongoing-monitoring/ (users.set_ongoing_monitoring): request body (documentation only)
  • PATCH /v3/session/{sessionId}/bulk-update-aml-hit-status/ (sessions.bulk_update_aml_hit_status): request body, response 200 (documentation only)
  • PATCH /v3/session/{sessionId}/kyb/{companyUuid}/update-data/ (sessions.update_kyb_company_data): response 200
    • response 200 registry_data.company_name: field added
    • response 200 registry_data.registration_number: field added
    • response 200 registry_data.country_code: field added
    • response 200 registry_data.region: field added
    • response 200 registry_data.incorporation_date: field added
    • response 200 registry_data.registration_date: field added
    • response 200 registry_data.dissolution_date: field added
    • response 200 registry_data.tax_number: field added
    • response 200 registry_data.vat_number: field added
    • response 200 registry_data.legal_address: field added
    • response 200 registry_data.registered_address: field added
    • response 200 registry_data.company_type: field added
    • response 200 registry_data.registry_status: field added
    • response 200 registry_data.verification_status: field added
    • response 200 registry_data.alternative_names: field added
    • response 200 registry_data.nature_of_business: field added
    • response 200 registry_data.registered_capital: field added
    • response 200 registry_data.registered_capital_amount: field added
    • response 200 registry_data.registered_capital_currency: field added
    • response 200 registry_data.website: field added
  • PATCH /v3/session/{sessionId}/update-aml-hit-status/ (sessions.update_aml_hit_status): request body, response 200 (documentation only)
  • PATCH /v3/session/{sessionId}/update-status/ (sessions.update_status): request body
    • request body nodes_to_resubmit[].feature: enum value GEOLOCATION added
  • PATCH /v3/transactions/rules/{rule_uuid}/ (transactions.rules.update): request body, response 200 (documentation only)
  • PATCH /v3/webhook/ (webhooks.update_config): request body, response 200
    • request body allowed_domains: field added
    • response 200 available_events[].value: enum value transaction_rule_suggestions.created added
    • response 200 allowed_domains: field added
  • PATCH /v3/webhook/destinations/{destination_uuid}/ (webhooks.destinations.update): request body, response 200
    • request body subscribed_events[]: enum value transaction_rule_suggestions.created added
    • response 200 subscribed_events[]: enum value transaction_rule_suggestions.created added
  • PATCH /v3/workflows/{settings_uuid}/ (workflows.update): request body, response 200
    • response 200 signature_availability: field added
  • POST /v1/transactions/: response 201 (documentation only)
  • POST /v3/aml/ (aml.screen): request body, response 200
  • POST /v3/database-validation/ (database_validation.validate): request body
    • request body company_registration_number: field added
    • request body company_name: field added
    • request body initials: field added
    • request body licence_number: field added
    • request body refugee_file_number: field added
    • request body bank_name: field added
    • request body bank_account_number: field added
    • request body account_type: field added
    • request body phone_number: field added
    • request body right_thumb: field added
    • request body left_thumb: field added
    • request body score_level: field added
    • request body max_matches: field added
    • request body vehicle_register_number: field added
    • request body vehicle_licence_plate: field added
    • request body vin: field added
  • POST /v3/email/check/ (email.check_code): request body, response 200
    • request body enable_enrichment: field added
    • request body email_intelligence_score_action: field added
    • request body recent_email_breach_action: field added
    • request body frequent_email_breach_action: field added
    • response 200 email.email_intelligence: field added
  • POST /v3/email/risk/ (email.assess_risk): response 200
    • breaking: response 200 email.email_intelligence.reason_codes[]: type changed from string to object
  • POST /v3/fraud/checks/ (fraud_checks.create): request body (documentation only)
  • POST /v3/fraud/checks/plan/ (fraud_checks.plan): request body (documentation only)
  • POST /v3/id-verification/ (id_verification.verify): response 200 (documentation only)
  • POST /v3/id-verification/wallets/audkenni/ (id_wallets.start_audkenni): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/bankid-cz/ (id_wallets.start_bankid_cz): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/bankid-no/ (id_wallets.start_bankid_no): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/bankid-se/ (id_wallets.start_bankid_se): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/buypass/ (id_wallets.start_buypass): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/connectid/ (id_wallets.start_connectid): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/diia/ (id_wallets.start_diia): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/eparaksts-mobile/ (id_wallets.start_eparaksts_mobile): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/eudi/ (id_wallets.start_eudi): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/franceconnect/ (id_wallets.start_franceconnect): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/frejaid/ (id_wallets.start_frejaid): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/ftn/ (id_wallets.start_ftn): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/govbr/ (id_wallets.start_govbr): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/govuk-wallet/ (id_wallets.start_govuk_wallet): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/idcard-ee/ (id_wallets.start_idcard_ee): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/idin/ (id_wallets.start_idin): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/itsme/ (id_wallets.start_itsme): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/mitid/ (id_wallets.start_mitid): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/mobile-id/ (id_wallets.start_mobile_id): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/mojeid/ (id_wallets.start_mojeid): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/oneid/ (id_wallets.start_oneid): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/personalausweis/ (id_wallets.start_personalausweis): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/smart-id/ (id_wallets.start_smart_id): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/uae-pass/ (id_wallets.start_uae_pass): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/id-verification/wallets/verifications/{request_id}/cancel/ (id_wallets.cancel_verification): response 200
    • 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
  • POST /v3/id-verification/wallets/verifications/{request_id}/poll/ (id_wallets.poll_verification): response 200
    • 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
  • POST /v3/id-verification/wallets/vipps/ (id_wallets.start_vipps): response 201
    • response 201 wallet_verification.interaction: enum value digital_credentials added
    • response 201 wallet_verification.next_action.type: enum value request_digital_credential added
    • response 201 wallet_verification.next_action.digital_credentials: field added
  • POST /v3/investigator/runs/{run_id}/accept/ (investigator.accept_run): request body (documentation only)
  • POST /v3/investigator/runs/{run_id}/override/ (investigator.override_run): request body (documentation only)
  • POST /v3/kyb/search/ (kyb.search): request body (documentation only)
  • POST /v3/kyb/select/ (kyb.select): request body, response 200
    • response 200 kyb_registry.registry_data.company_name: field added
    • response 200 kyb_registry.registry_data.registration_number: field added
    • response 200 kyb_registry.registry_data.country_code: field added
    • response 200 kyb_registry.registry_data.region: field added
    • response 200 kyb_registry.registry_data.incorporation_date: field added
    • response 200 kyb_registry.registry_data.registration_date: field added
    • response 200 kyb_registry.registry_data.dissolution_date: field added
    • response 200 kyb_registry.registry_data.tax_number: field added
    • response 200 kyb_registry.registry_data.vat_number: field added
    • response 200 kyb_registry.registry_data.legal_address: field added
    • response 200 kyb_registry.registry_data.registered_address: field added
    • response 200 kyb_registry.registry_data.company_type: field added
    • response 200 kyb_registry.registry_data.registry_status: field added
    • response 200 kyb_registry.registry_data.verification_status: field added
    • response 200 kyb_registry.registry_data.alternative_names: field added
    • response 200 kyb_registry.registry_data.nature_of_business: field added
    • response 200 kyb_registry.registry_data.registered_capital: field added
    • response 200 kyb_registry.registry_data.registered_capital_amount: field added
    • response 200 kyb_registry.registry_data.registered_capital_currency: field added
    • response 200 kyb_registry.registry_data.website: field added
  • POST /v3/kyb/shareholders/ (kyb.list_shareholders): request body, response 200, response 202
    • response 200 kyb_registry.registry_data.company_name: field added
    • response 200 kyb_registry.registry_data.registration_number: field added
    • response 200 kyb_registry.registry_data.country_code: field added
    • response 200 kyb_registry.registry_data.region: field added
    • response 200 kyb_registry.registry_data.incorporation_date: field added
    • response 200 kyb_registry.registry_data.registration_date: field added
    • response 200 kyb_registry.registry_data.dissolution_date: field added
    • response 200 kyb_registry.registry_data.tax_number: field added
    • response 200 kyb_registry.registry_data.vat_number: field added
    • response 200 kyb_registry.registry_data.legal_address: field added
    • response 200 kyb_registry.registry_data.registered_address: field added
    • response 200 kyb_registry.registry_data.company_type: field added
    • response 200 kyb_registry.registry_data.registry_status: field added
    • response 200 kyb_registry.registry_data.verification_status: field added
    • response 200 kyb_registry.registry_data.alternative_names: field added
    • response 200 kyb_registry.registry_data.nature_of_business: field added
    • response 200 kyb_registry.registry_data.registered_capital: field added
    • response 200 kyb_registry.registry_data.registered_capital_amount: field added
    • response 200 kyb_registry.registry_data.registered_capital_currency: field added
    • response 200 kyb_registry.registry_data.website: field added
  • POST /v3/kyb/ubo/ (kyb.list_ubos): request body, response 200, response 202
    • response 200 kyb_registry.registry_data.company_name: field added
    • response 200 kyb_registry.registry_data.registration_number: field added
    • response 200 kyb_registry.registry_data.country_code: field added
    • response 200 kyb_registry.registry_data.region: field added
    • response 200 kyb_registry.registry_data.incorporation_date: field added
    • response 200 kyb_registry.registry_data.registration_date: field added
    • response 200 kyb_registry.registry_data.dissolution_date: field added
    • response 200 kyb_registry.registry_data.tax_number: field added
    • response 200 kyb_registry.registry_data.vat_number: field added
    • response 200 kyb_registry.registry_data.legal_address: field added
    • response 200 kyb_registry.registry_data.registered_address: field added
    • response 200 kyb_registry.registry_data.company_type: field added
    • response 200 kyb_registry.registry_data.registry_status: field added
    • response 200 kyb_registry.registry_data.verification_status: field added
    • response 200 kyb_registry.registry_data.alternative_names: field added
    • response 200 kyb_registry.registry_data.nature_of_business: field added
    • response 200 kyb_registry.registry_data.registered_capital: field added
    • response 200 kyb_registry.registry_data.registered_capital_amount: field added
    • response 200 kyb_registry.registry_data.registered_capital_currency: field added
    • response 200 kyb_registry.registry_data.website: field added
  • POST /v3/organization/{organization_id}/application/{application_id}/cases/ (cases.create): request body (documentation only)
  • POST /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/ (cases.blueprints.create): request body (documentation only)
  • POST /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/presets/install/ (cases.blueprints.install_presets): request body (documentation only)
  • POST /v3/organization/{organization_id}/application/{application_id}/cases/bulk/assign/ (cases.bulk_assign): request body (documentation only)
  • POST /v3/organization/{organization_id}/application/{application_id}/cases/bulk/status/ (cases.bulk_update_status): request body (documentation only)
  • POST /v3/organization/{organization_id}/application/{application_id}/cases/duplicates/ (cases.find_duplicates): request body (documentation only)
  • POST /v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/ (cases.routing_rules.create): request body (documentation only)
  • POST /v3/organization/{organization_id}/application/{application_id}/cases/teams/ (cases.teams.create): request body (documentation only)
  • POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/assign/ (cases.assign): request body (documentation only)
  • POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/entity-actions/ (cases.apply_entity_action): request body (documentation only)
  • POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/links/ (cases.links.create): request body (documentation only)
  • POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/ (cases.notes.create): request body (documentation only)
  • POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/ (cases.regulatory_reports.create): request body (documentation only)
  • POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/reject-approval/ (cases.reject_resolution): request body (documentation only)
  • POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/transfer/ (cases.transfer): request body (documentation only)
  • ... and 25 more

Schemas

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

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

  • email.assess_risk() (POST /v3/email/risk/): response 200 email.email_intelligence.reason_codes[]: type changed from string to object
  • phone.assess_risk() (POST /v3/phone/risk/): response 200 phone.phone_intelligence.reason_codes[]: type changed from string to object

@github-actions github-actions Bot changed the title chore(spec): sync API spec 2026-10-30 chore(spec): sync API spec 2026-10-31 Oct 31, 2026
Generated by .github/workflows/spec-sync.yml from the upstream OpenAPI documents.

BREAKING CHANGE: the API spec sync changes the SDK surface.
- `email.assess_risk()` (`POST /v3/email/risk/`): response 200 `email.email_intelligence.reason_codes[]`: type changed from string to object
- `phone.assess_risk()` (`POST /v3/phone/risk/`): response 200 `phone.phone_intelligence.reason_codes[]`: type changed from string to object
@github-actions github-actions Bot changed the title chore(spec): sync API spec 2026-10-31 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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants