Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arosasg merged 1 commit into from
Oct 29, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 36 additions & 12 deletions api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# API reference

Every method of `@didit-protocol/sdk-node`: 359 methods, generated from `openapi/`. Path parameters are positional, the other fields go in one `params` object, and every method takes request options as its last argument. Every type named here is exported from the package. _Application scoped_ methods need the `organizationId` and `applicationId` client options; a _page_ can be iterated with `for await`. Webhook verification and Authentication are described in the README.
Every method of `@didit-protocol/sdk-node`: 368 methods, generated from `openapi/`. Path parameters are positional, the other fields go in one `params` object, and every method takes request options as its last argument. Every type named here is exported from the package. _Application scoped_ methods need the `organizationId` and `applicationId` client options; a _page_ can be iterated with `for await`. Webhook verification and Authentication are described in the README.

## `didit.account`

Expand All @@ -28,6 +28,12 @@ Every method of `@didit-protocol/sdk-node`: 359 methods, generated from `openapi
| --------------------------------------------------------------------------- | ------------------------ | ---------------------- | -------------------- |
| `didit.account.organizations.list(params?: AccountOrganizationsListParams)` | `GET /organizations/me/` | page of `Organization` | needs `accountToken` |

## `didit.addressValidation`

| Method | HTTP | Returns | Notes |
| --------------------------------------------------------------------------- | ------------------------------ | --------------------------- | ----- |
| `didit.addressValidation.validate(params: AddressValidationValidateParams)` | `POST /v3/address-validation/` | `AddressValidationResponse` | |

## `didit.ageEstimation`

| Method | HTTP | Returns | Notes |
Expand Down Expand Up @@ -440,7 +446,7 @@ Every method of `@didit-protocol/sdk-node`: 359 methods, generated from `openapi
| Method | HTTP | Returns | Notes |
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ------------------ |
| `didit.regulatoryReports.create(params: RegulatoryReportsCreateParams)` | `POST /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/` | `RegulatoryReportDetail` | application scoped |
| `didit.regulatoryReports.delete(reportUuid)` | `DELETE /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/` | nothing | application scoped |
| `didit.regulatoryReports.delete(reportUuid, params?: RegulatoryReportsDeleteParams)` | `DELETE /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/` | nothing | application scoped |
| `didit.regulatoryReports.finalize(reportUuid)` | `POST /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/finalize/` | `RegulatoryReportDetail` | application scoped |
| `didit.regulatoryReports.list(params?: RegulatoryReportsListParams)` | `GET /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/` | page of `RegulatoryReportDetail` | application scoped |
| `didit.regulatoryReports.retrieve(reportUuid)` | `GET /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/` | `RegulatoryReportDetail` | application scoped |
Expand Down Expand Up @@ -537,16 +543,17 @@ Every method of `@didit-protocol/sdk-node`: 359 methods, generated from `openapi

## `didit.transactions`

| Method | HTTP | Returns | Notes |
| --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------- | ------------------ |
| `didit.transactions.create(params: TransactionsCreateParams)` | `POST /v3/transactions/` | `TransactionDetail` | |
| `didit.transactions.createSdkToken(params: TransactionsCreateSdkTokenParams)` | `POST /v3/transactions/sdk-token/` | `TransactionsCreateSdkTokenResponse` | |
| `didit.transactions.generatePdf(transactionUuid)` | `GET /v3/organization/{organization_id}/application/{application_id}/transactions/{transaction_uuid}/pdf/` | `Blob` | application scoped |
| `didit.transactions.list(params?: TransactionsListParams)` | `GET /v3/transactions/` | page of `TransactionsListResponseResults` | |
| `didit.transactions.listNetworks(transactionUuid)` | `GET /v3/organization/{organization_id}/application/{application_id}/transactions/{transaction_uuid}/networks/` | `EntityNetworkMembershipList` | application scoped |
| `didit.transactions.listPartyNetworks(transactionUuid, transactionPartyUuid)` | `GET /v3/organization/{organization_id}/application/{application_id}/transactions/{transaction_uuid}/parties/{transaction_party_uuid}/networks/` | `EntityNetworkMembershipList` | application scoped |
| `didit.transactions.listRelated(transactionId, params?: TransactionsListRelatedParams)` | `GET /v3/transactions/{transaction_id}/related/` | page of `TransactionSummary` | |
| `didit.transactions.retrieve(transactionId)` | `GET /v3/transactions/{transaction_id}/` | `TransactionDetail` | |
| Method | HTTP | Returns | Notes |
| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------- | ------------------ |
| `didit.transactions.batchDelete(params: TransactionsBatchDeleteParamsSelectedTransactions \| TransactionsBatchDeleteParamsAllTransactions)` | `DELETE /v3/organization/{organization_id}/application/{application_id}/transactions/delete/` | nothing | application scoped |
| `didit.transactions.create(params: TransactionsCreateParams)` | `POST /v3/transactions/` | `TransactionDetail` | |
| `didit.transactions.createSdkToken(params: TransactionsCreateSdkTokenParams)` | `POST /v3/transactions/sdk-token/` | `TransactionsCreateSdkTokenResponse` | |
| `didit.transactions.generatePdf(transactionUuid)` | `GET /v3/organization/{organization_id}/application/{application_id}/transactions/{transaction_uuid}/pdf/` | `Blob` | application scoped |
| `didit.transactions.list(params?: TransactionsListParams)` | `GET /v3/transactions/` | page of `TransactionsListResponseResults` | |
| `didit.transactions.listNetworks(transactionUuid)` | `GET /v3/organization/{organization_id}/application/{application_id}/transactions/{transaction_uuid}/networks/` | `EntityNetworkMembershipList` | application scoped |
| `didit.transactions.listPartyNetworks(transactionUuid, transactionPartyUuid)` | `GET /v3/organization/{organization_id}/application/{application_id}/transactions/{transaction_uuid}/parties/{transaction_party_uuid}/networks/` | `EntityNetworkMembershipList` | application scoped |
| `didit.transactions.listRelated(transactionId, params?: TransactionsListRelatedParams)` | `GET /v3/transactions/{transaction_id}/related/` | page of `TransactionSummary` | |
| `didit.transactions.retrieve(transactionId)` | `GET /v3/transactions/{transaction_id}/` | `TransactionDetail` | |

## `didit.transactions.notes`

Expand Down Expand Up @@ -606,6 +613,16 @@ Every method of `@didit-protocol/sdk-node`: 359 methods, generated from `openapi
| `didit.travelRule.counterpartyContacts.delete(contactUuid)` | `DELETE /v3/travel-rule/counterparty-contacts/{contact_uuid}/` | nothing | |
| `didit.travelRule.counterpartyContacts.list(params?: TravelRuleCounterpartyContactsListParams)` | `GET /v3/travel-rule/counterparty-contacts/` | page of `TravelRuleCounterpartyContact` | |

## `didit.travelRule.networks`

| Method | HTTP | Returns | Notes |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -------------------------------- | ----- |
| `didit.travelRule.networks.requestAccess(network)` | `POST /v3/travel-rule/networks/{network}/request/` | `TravelRuleNetworkParticipant` | |
| `didit.travelRule.networks.retrieve()` | `GET /v3/travel-rule/networks/` | `TravelRuleNetworksOverview` | |
| `didit.travelRule.networks.retrieveQuestionnaire()` | `GET /v3/travel-rule/networks/questionnaire/` | `TravelRuleNetworkQuestionnaire` | |
| `didit.travelRule.networks.submitQuestionnaire()` | `POST /v3/travel-rule/networks/questionnaire/submit/` | `TravelRuleNetworkQuestionnaire` | |
| `didit.travelRule.networks.updateQuestionnaire(params?: TravelRuleNetworksUpdateQuestionnaireParams)` | `PUT /v3/travel-rule/networks/questionnaire/` | `TravelRuleNetworkQuestionnaire` | |

## `didit.travelRule.transfers`

| Method | HTTP | Returns | Notes |
Expand All @@ -622,6 +639,13 @@ Every method of `@didit-protocol/sdk-node`: 359 methods, generated from `openapi
| `didit.travelRule.walletAddresses.list(params?: TravelRuleWalletAddressesListParams)` | `GET /v3/travel-rule/wallet-addresses/` | page of `WalletAddressEntry` | |
| `didit.travelRule.walletAddresses.update(entryUuid, params?: TravelRuleWalletAddressesUpdateParams)` | `PATCH /v3/travel-rule/wallet-addresses/{entry_uuid}/` | `WalletAddressEntryUpdate` | |

## `didit.travelRule.walletProofs`

| Method | HTTP | Returns | Notes |
| --------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | ------------------------------------- | ----- |
| `didit.travelRule.walletProofs.decide(proofUuid, params: TravelRuleWalletProofsDecideParams)` | `POST /v3/travel-rule/wallet-proofs/{proof_uuid}/decision/` | `TravelRuleWalletProofReview` | |
| `didit.travelRule.walletProofs.list(params?: TravelRuleWalletProofsListParams)` | `GET /v3/travel-rule/wallet-proofs/` | page of `TravelRuleWalletProofReview` | |

## `didit.travelRule.workspace`

| Method | HTTP | Returns | Notes |
Expand Down
8 changes: 4 additions & 4 deletions openapi/SOURCE.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"verification.json": {
"url": "https://docs.didit.me/openapi-25.json",
"sha256": "b2658eb22e23f868d2df5fe513c8dcdadce3abf2e35d1bbebce0382c911038db",
"fetched_at": "2026-10-27T06:59:31Z"
"sha256": "12b2fdb05572755d61b93791f6964b7d883ba7b20f7ea9b31543903b6edab8a9",
"fetched_at": "2026-10-29T06:47:08Z"
},
"account.json": {
"url": "https://docs.didit.me/openapi-auth.json",
"sha256": "5fafb88b306ab60c7c105b0bf00fa2a6a49b5d2ca8115eb003b332f073844b39",
"fetched_at": "2026-10-27T06:59:31Z"
"sha256": "ae1b5e07df822fe93cae27a9eaa0790948069352c9d98c87eecf7efd644c92cb",
"fetched_at": "2026-10-29T06:47:08Z"
},
"webhook-vectors.json": {
"generator": "product-automations scripts/server-sdks/make_vectors.py (seeded 2026-10-17)",
Expand Down
Loading