Skip to content

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

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

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

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()
  • POST /v3/travel-rule/widget/{token}/proofs/: not exposed by the server SDKs
  • POST /v3/travel-rule/widget/{token}/proofs/{proof_id}/verify/: not exposed by the server SDKs
  • POST /v3/travel-rule/widget/{token}/vasps/: not exposed by the server SDKs
  • PUT /v3/travel-rule/networks/questionnaire/: travel_rule.networks.update_questionnaire()

Changed (46)

  • DELETE /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/ (regulatory_reports.delete): request body, response 204
    • request body: added
  • GET /v1/transactions/{transaction_id}/: response 200 (documentation only)
  • GET /v3/billing/balance/ (billing.retrieve_balance): response 200 (documentation only)
  • GET /v3/organization/{organization_id}/application/{application_id}/networks/ (networks.list): response 200 (documentation only)
  • GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/ (networks.retrieve): response 200 (documentation only)
  • GET /v3/session/{sessionId}/decision/ (sessions.retrieve_decision): response 200
    • 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): parameters (documentation only)
  • GET /v3/transactions/ (transactions.list): response 200 (documentation only)
  • GET /v3/transactions/{transaction_id}/ (transactions.retrieve): response 200 (documentation only)
  • GET /v3/travel-rule/settings/ (travel_rule.retrieve_settings): response 200
    • response 200 networks.gtr.rail: enum value 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): response 200 (documentation only)
  • GET /v3/travel-rule/widget/{token}/: response 200
    • 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
    • response 200 settings.networks.gtr.rail: enum value 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
    • response 200 biometric_consent_mode: field added
  • GET /v3/workflows/{settings_uuid}/ (workflows.retrieve): response 200 (documentation only)
  • PATCH /v3/transactions/{transaction_id}/travel-rule/ (transactions.travel_rule.update_transfer): request body, response 200
    • request body action: enum value beneficiary_vasp added
    • request body beneficiary_vasp: field added
  • PATCH /v3/webhook/ (webhooks.update_config): request body, response 200
    • request body biometric_consent_mode: field added
    • response 200 biometric_consent_mode: field added
  • PATCH /v3/workflows/{settings_uuid}/ (workflows.update): response 200 (documentation only)
  • POST /v1/transactions/: response 201 (documentation only)
  • POST /v3/billing/top-up/ (billing.top_up): request body
  • POST /v3/email/check/ (email.check_code): response 200 (documentation only)
  • POST /v3/id-verification/ (id_verification.verify): request body, response 200
    • response 200 id_verification.status: enum value In Review added
  • POST /v3/kyb/select/ (kyb.select): response 200
    • 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, response 202
    • 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, response 202
    • 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): response 200, response 201 (documentation only)
  • POST /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/remove/ (networks.remove_tag): response 200 (documentation only)
  • POST /v3/phone/check/ (phone.check_code): response 200 (documentation only)
  • POST /v3/session/ (sessions.create): request body, response 201
    • 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
    • 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/transactions/ (transactions.create): response 201 (documentation only)
  • POST /v3/transactions/{transaction_id}/travel-rule/ownership/ (transactions.travel_rule.confirm_ownership): response 200 (documentation only)
  • POST /v3/travel-rule/inbound/ (travel_rule.register_inbound): response 200, response 201 (documentation only)
  • POST /v3/travel-rule/test-vasp/inbound/ (transactions.travel_rule.trigger_test_vasp_inbound): response 201 (documentation only)
  • POST /v3/travel-rule/wallet-addresses/ (travel_rule.wallet_addresses.create): request body, response 201 (documentation only)
  • POST /v3/travel-rule/widget-session/ (travel_rule.create_widget_session): request body (documentation only)
  • POST /v3/travel-rule/workspace/billing/ (travel_rule.workspace.enable_billing): response 200
    • response 200 settings.networks.gtr.rail: enum value 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
    • response 200 settings.networks.gtr.rail: enum value 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
    • response 200 settings.networks.gtr.rail: enum value 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
    • response 200 settings.networks.gtr.rail: enum value 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/workflows/ (workflows.create): response 201 (documentation only)
  • PUT /v3/travel-rule/settings/ (travel_rule.update_settings): response 200
    • response 200 networks.gtr.rail: enum value 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): response 200 (documentation only)
  • account GET /organizations/me/{org_id}/applications/{app_id}/ (account.applications.retrieve): response 200 (documentation only)
  • account PATCH /organizations/me/{org_id}/applications/{app_id}/ (account.applications.update): response 200 (documentation only)
  • account POST /organizations/me/{org_id}/applications/ (account.applications.create): response 201 (documentation only)

Schemas

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

Generated by .github/workflows/spec-sync.yml from the upstream OpenAPI documents.
@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 c85dc29 into main Oct 29, 2026
@arosasg
arosasg deleted the chore/spec-sync branch October 29, 2026 07:15
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