Skip to content

chore(spec): sync API spec 2026-10-29 - #15

Merged
arosasg merged 1 commit into
mainfrom
chore/spec-sync
Oct 29, 2026
Merged

arosasg merged 1 commit into
mainfrom
chore/spec-sync

Conversation

@github-actions

@github-actions github-actions Bot commented Oct 28, 2026 •

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: 53 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 b2658eb22e23f868d2df5fe513c8dcdadce3abf2e35d1bbebce0382c911038db 12b2fdb05572755d61b93791f6964b7d883ba7b20f7ea9b31543903b6edab8a9
openapi/account.json https://docs.didit.me/openapi-auth.json 5fafb88b306ab60c7c105b0bf00fa2a6a49b5d2ca8115eb003b332f073844b39 ae1b5e07df822fe93cae27a9eaa0790948069352c9d98c87eecf7efd644c92cb

Breaking changes

None detected.

Operations

Added (12)

  • DELETE /v3/organization/{organization_id}/application/{application_id}/transactions/delete/: transactions.batch_delete
  • GET /v3/travel-rule/networks/: travel_rule.networks.retrieve
  • GET /v3/travel-rule/networks/questionnaire/: travel_rule.networks.retrieve_questionnaire
  • GET /v3/travel-rule/wallet-proofs/: travel_rule.wallet_proofs.list
  • POST /v3/address-validation/: address_validation.validate
  • POST /v3/travel-rule/networks/questionnaire/submit/: travel_rule.networks.submit_questionnaire
  • POST /v3/travel-rule/networks/{network}/request/: travel_rule.networks.request_access
  • POST /v3/travel-rule/wallet-proofs/{proof_uuid}/decision/: travel_rule.wallet_proofs.decide
  • PUT /v3/travel-rule/networks/questionnaire/: travel_rule.networks.update_questionnaire
  • POST /v3/travel-rule/widget/{token}/proofs/: not exposed by the server SDKs (auth public)
  • POST /v3/travel-rule/widget/{token}/proofs/{proof_id}/verify/: not exposed by the server SDKs (auth public)
  • POST /v3/travel-rule/widget/{token}/vasps/: not exposed by the server SDKs (auth public)

Changed (60)

  • DELETE /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/ (cases.delete): details changed (formats, limits, error responses or similar)
  • DELETE /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/ (regulatory_reports.delete)
    • request body: added
  • DELETE /v3/session/{sessionId}/delete/ (sessions.delete): details changed (formats, limits, error responses or similar)
  • GET /v1/transactions/{transaction_id}/ (not exposed by the server SDKs): documentation only
  • GET /v3/billing/balance/ (billing.retrieve_balance): 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/session/{sessionId}/decision/ (sessions.retrieve_decision)
    • response 200 id_verifications[].address_validation: field added
    • response 200 poa_verifications[].address_validation: field added
    • response 200 registry_checks[].company.ownership.status: enum value not_held added
    • response 200 biometric_consent: field added
  • GET /v3/sessions/ (sessions.list): documentation only
  • GET /v3/transactions/ (transactions.list): documentation only
  • GET /v3/transactions/{transaction_id}/ (transactions.retrieve): documentation only
  • GET /v3/travel-rule/settings/ (travel_rule.retrieve_settings)
    • response 200 networks.gtr.rail: enum values TRUST, VERIFYVASP, SYGNA added
    • response 200 networks.gtr.state: field added
    • response 200 networks.gtr.reason: field added
    • response 200 networks.gtr.participant: field added
    • response 200 networks.gtr.vasps_reachable: field added
    • response 200 networks.gtr.routed_30d: field added
  • GET /v3/travel-rule/wallet-addresses/ (travel_rule.wallet_addresses.list): documentation only
  • GET /v3/travel-rule/widget/{token}/ (not exposed by the server SDKs)
    • response 200 proofs[].attempts: field added
    • response 200 proofs[].failure_reason: field added
    • response 200 chain_family: field added
  • GET /v3/travel-rule/workspace/ (travel_rule.workspace.get)
    • response 200 settings.networks.gtr.rail: enum values TRUST, VERIFYVASP, SYGNA added
    • response 200 settings.networks.gtr.state: field added
    • response 200 settings.networks.gtr.reason: field added
    • response 200 settings.networks.gtr.participant: field added
    • response 200 settings.networks.gtr.vasps_reachable: field added
    • response 200 settings.networks.gtr.routed_30d: field added
  • GET /v3/webhook/ (webhooks.retrieve_config)
    • response 200 biometric_consent_mode: field added
  • GET /v3/workflows/{settings_uuid}/ (workflows.retrieve): documentation only
  • PATCH /v3/transactions/{transaction_id}/travel-rule/ (transactions.travel_rule.update_transfer)
    • request body action: enum value beneficiary_vasp added
    • request body beneficiary_vasp: field added
  • PATCH /v3/webhook/ (webhooks.update_config)
    • request body biometric_consent_mode: field added
    • response 200 biometric_consent_mode: field added
  • PATCH /v3/workflows/{settings_uuid}/ (workflows.update): documentation only
  • POST /v1/transactions/ (not exposed by the server SDKs): documentation only
  • POST /v3/age-estimation/ (age_estimation.estimate): documentation only
  • POST /v3/billing/top-up/ (billing.top_up): details changed (formats, limits, error responses or similar)
  • POST /v3/businesses/delete/ (businesses.batch_delete): details changed (formats, limits, error responses or similar)
  • POST /v3/document-ai/ (document_ai.analyze): documentation only
  • POST /v3/email/check/ (email.check_code): documentation only
  • POST /v3/face-match/ (face_match.compare): documentation only
  • POST /v3/face-search/ (face_search.search): documentation only
  • POST /v3/id-verification/ (id_verification.verify)
    • response 200 id_verification.status: enum value In Review added
  • POST /v3/kyb/select/ (kyb.select)
    • response 200 kyb_registry.registry_ownership_status: enum value not_held added
    • response 200 kyb_registry.ownership.status: enum value not_held added
  • POST /v3/kyb/shareholders/ (kyb.list_shareholders)
    • response 200 kyb_registry.registry_ownership_status: enum value not_held added
    • response 200 kyb_registry.ownership.status: enum value not_held added
    • response 202 kyb_registry.registry_ownership_status: enum value not_held added
  • POST /v3/kyb/ubo/ (kyb.list_ubos)
    • response 200 kyb_registry.registry_ownership_status: enum value not_held added
    • response 200 kyb_registry.ownership.status: enum value not_held added
    • response 202 kyb_registry.registry_ownership_status: enum value not_held added
  • POST /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/add/ (networks.add_tag): documentation only
  • POST /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/remove/ (networks.remove_tag): documentation only
  • POST /v3/passive-liveness/ (passive_liveness.check): documentation only
  • POST /v3/phone/check/ (phone.check_code): documentation only
  • POST /v3/poa/ (proof_of_address.verify): documentation only
  • POST /v3/session/ (sessions.create)
    • request body tags: field added
    • request body user_state: field added
    • request body biometric_consent: field added
    • response 201 tags: field added
  • POST /v3/session/import-shared/ (sessions.import_shared)
    • response 201 id_verifications[].address_validation: field added
    • response 201 poa_verifications[].address_validation: field added
    • response 201 registry_checks[].company.ownership.status: enum value not_held added
    • response 201 biometric_consent: field added
  • POST /v3/sessions/delete/ (sessions.batch_delete): details changed (formats, limits, error responses or similar)
  • POST /v3/transactions/ (transactions.create): documentation only
  • POST /v3/transactions/{transaction_id}/travel-rule/ownership/ (transactions.travel_rule.confirm_ownership): documentation only
  • POST /v3/travel-rule/inbound/ (travel_rule.register_inbound): documentation only
  • POST /v3/travel-rule/test-vasp/inbound/ (transactions.travel_rule.trigger_test_vasp_inbound): documentation only
  • POST /v3/travel-rule/wallet-addresses/ (travel_rule.wallet_addresses.create): documentation only
  • POST /v3/travel-rule/widget-session/ (travel_rule.create_widget_session): documentation only
  • POST /v3/travel-rule/workspace/billing/ (travel_rule.workspace.enable_billing)
    • response 200 settings.networks.gtr.rail: enum values TRUST, VERIFYVASP, SYGNA added
    • response 200 settings.networks.gtr.state: field added
    • response 200 settings.networks.gtr.reason: field added
    • response 200 settings.networks.gtr.participant: field added
    • response 200 settings.networks.gtr.vasps_reachable: field added
    • response 200 settings.networks.gtr.routed_30d: field added
  • POST /v3/travel-rule/workspace/claim/ (travel_rule.workspace.claim)
    • response 200 settings.networks.gtr.rail: enum values TRUST, VERIFYVASP, SYGNA added
    • response 200 settings.networks.gtr.state: field added
    • response 200 settings.networks.gtr.reason: field added
    • response 200 settings.networks.gtr.participant: field added
    • response 200 settings.networks.gtr.vasps_reachable: field added
    • response 200 settings.networks.gtr.routed_30d: field added
  • POST /v3/travel-rule/workspace/domain/confirm/ (travel_rule.workspace.confirm_domain)
    • response 200 settings.networks.gtr.rail: enum values TRUST, VERIFYVASP, SYGNA added
    • response 200 settings.networks.gtr.state: field added
    • response 200 settings.networks.gtr.reason: field added
    • response 200 settings.networks.gtr.participant: field added
    • response 200 settings.networks.gtr.vasps_reachable: field added
    • response 200 settings.networks.gtr.routed_30d: field added
  • POST /v3/travel-rule/workspace/domain/dns/ (travel_rule.workspace.verify_domain_dns)
    • response 200 settings.networks.gtr.rail: enum values TRUST, VERIFYVASP, SYGNA added
    • response 200 settings.networks.gtr.state: field added
    • response 200 settings.networks.gtr.reason: field added
    • response 200 settings.networks.gtr.participant: field added
    • response 200 settings.networks.gtr.vasps_reachable: field added
    • response 200 settings.networks.gtr.routed_30d: field added
  • POST /v3/users/delete/ (users.batch_delete): details changed (formats, limits, error responses or similar)
  • POST /v3/workflows/ (workflows.create): documentation only
  • PUT /v3/travel-rule/settings/ (travel_rule.update_settings)
    • response 200 networks.gtr.rail: enum values TRUST, VERIFYVASP, SYGNA added
    • response 200 networks.gtr.state: field added
    • response 200 networks.gtr.reason: field added
    • response 200 networks.gtr.participant: field added
    • response 200 networks.gtr.vasps_reachable: field added
    • response 200 networks.gtr.routed_30d: field added
  • account GET /organizations/me/{org_id}/applications/ (account.applications.list): documentation only
  • account GET /organizations/me/{org_id}/applications/{app_id}/ (account.applications.retrieve): documentation only
  • account PATCH /organizations/me/{org_id}/applications/{app_id}/ (account.applications.update): documentation only
  • account POST /organizations/me/{org_id}/applications/ (account.applications.create): details changed (formats, limits, error responses or similar)
  • account POST /programmatic/login/ (account.login): details changed (formats, limits, error responses or similar)
  • account POST /programmatic/register/ (account.register): details changed (formats, limits, error responses or similar)
  • account POST /programmatic/resend-otp/ (account.resend_otp): documentation only

Schemas

  • AddressValidationRequest added (verification.json)
  • AddressValidationResponse added (verification.json)
  • AddressValidationResult added (verification.json)
  • FiledRegulatoryReport added (verification.json)
  • FiledReportTransaction added (verification.json)
  • InFiledReportError added (verification.json)
  • TravelRuleNetworkParticipant added (verification.json)
  • TravelRuleNetworkParticipantSummary added (verification.json)
  • TravelRuleNetworkQuestionnaire added (verification.json)
  • TravelRuleNetworkQuestionnaireAnswers added (verification.json)
  • TravelRuleNetworkState added (verification.json)
  • TravelRuleNetworksOverview added (verification.json)
  • TravelRuleWalletProofDecision added (verification.json)
  • TravelRuleWalletProofFailureReason added (verification.json)
  • TravelRuleWalletProofReview added (verification.json)
  • TravelRuleWidgetProofCreate added (verification.json)
  • TravelRuleWidgetProofError added (verification.json)
  • TravelRuleWidgetProofVerifyResult added (verification.json)
  • KYBRegistryOwnership changed (verification.json)
  • NetworkDetailResponse changed (verification.json), documentation only
  • SessionDecision changed (verification.json)
  • TravelRuleNextAction changed (verification.json), documentation only
  • TravelRuleSettingsDetail changed (verification.json)
  • TravelRuleTransferPatchRequest changed (verification.json)
  • TravelRuleWidgetContext changed (verification.json)
  • TravelRuleWidgetProofSummary changed (verification.json)
  • TravelRuleWidgetSessionCreate changed (verification.json), documentation only
  • WalletAddressEntry changed (verification.json), documentation only
  • WalletAddressEntryCreate changed (verification.json), documentation only
  • WebhookConfig changed (verification.json)
  • WorkflowDetail changed (verification.json), documentation only
  • EmailUndeliverableError added (account.json)
  • RecoveryHoldError added (account.json)
  • RecoverySetupRequiredError added (account.json)
  • Application changed (account.json), documentation only

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 40831595756.

Synced openapi/verification.json and openapi/account.json from the published API contract (docs/DESIGN.md section 3.1).
Operations: 12 added, 0 removed, 0 renamed, 0 moved, 60 changed.
Regenerated the SDK.
@github-actions github-actions Bot changed the title chore(spec): sync API spec 2026-10-28 chore(spec): sync API spec 2026-10-29 Oct 29, 2026
@arosasg
arosasg merged commit 468dbfc into main Oct 29, 2026
@arosasg
arosasg deleted the chore/spec-sync branch October 29, 2026 07:16
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.

1 participant