api.md

API reference

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

Method	HTTP	Returns	Notes
didit.account.login(params: AccountLoginParams)	POST /programmatic/login/	LoginResponse
didit.account.register(params: AccountRegisterParams)	POST /programmatic/register/	RegisterResponse
didit.account.resendOtp(params: AccountResendOtpParams)	POST /programmatic/resend-otp/	AccountResendOtpResponse
didit.account.verifyEmail(params: AccountVerifyEmailParams)	POST /programmatic/verify-email/	VerifyEmailResponse

didit.account.applications

Method	HTTP	Returns	Notes
didit.account.applications.create(orgId, params?: AccountApplicationsCreateParams)	POST /organizations/me/{org_id}/applications/	Application	needs accountToken
didit.account.applications.list(orgId, params?: AccountApplicationsListParams)	GET /organizations/me/{org_id}/applications/	page of Application	needs accountToken
didit.account.applications.retrieve(orgId, appId)	GET /organizations/me/{org_id}/applications/{app_id}/	Application	needs accountToken
didit.account.applications.update(orgId, appId, params?: AccountApplicationsUpdateParams)	PATCH /organizations/me/{org_id}/applications/{app_id}/	Application	needs accountToken

didit.account.organizations

Method	HTTP	Returns	Notes
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
didit.ageEstimation.estimate(params: AgeEstimationEstimateParams)	POST /v3/age-estimation/	AgeEstimationEstimateResponse	upload

didit.aml

Method	HTTP	Returns	Notes
didit.aml.retrieveDatasetFreshness()	GET /v3/aml/dataset-freshness/	AmlRetrieveDatasetFreshnessResponse
didit.aml.screen(params: AmlScreenParams)	POST /v3/aml/	AmlScreenResponse	idempotencyKey

didit.amlMonitoring

Method	HTTP	Returns	Notes
didit.amlMonitoring.retrieveJob(jobId)	GET /v3/aml-monitoring/jobs/{job_id}/	AmlMonitoringRetrieveJobResponse

didit.analytics

Method	HTTP	Returns	Notes
didit.analytics.retrieve(params?: AnalyticsRetrieveParams)	GET /v3/organization/{organization_id}/application/{application_id}/analytics/	ApplicationAnalyticsSummary | ApplicationAnalyticsWidgetResponse	application scoped

didit.bank

Method	HTTP	Returns	Notes
didit.bank.accountCheck(params: BankAccountCheckParams)	POST /v3/bank/account-check/	BankAccountCheckResponse

didit.billing

Method	HTTP	Returns	Notes
didit.billing.retrieveBalance()	GET /v3/billing/balance/	BillingRetrieveBalanceResponse
didit.billing.topUp(params: BillingTopUpParams)	POST /v3/billing/top-up/	BillingTopUpResponse

didit.biometricTemplates

Method	HTTP	Returns	Notes
didit.biometricTemplates.batchDelete(params?: BiometricTemplatesBatchDeleteParams)	POST /v3/biometric-templates/delete/	BiometricTemplatesBatchDeleteResponse
didit.biometricTemplates.count(params?: BiometricTemplatesCountParams)	GET /v3/biometric-templates/count/	BiometricTemplatesCountResponse
didit.biometricTemplates.delete(templateUuid)	DELETE /v3/biometric-templates/{template_uuid}/	BiometricTemplatesDeleteResponse
didit.biometricTemplates.list(params?: BiometricTemplatesListParams)	GET /v3/biometric-templates/	page of BiometricTemplatesListResponseResults
didit.biometricTemplates.retrieve(templateUuid)	GET /v3/biometric-templates/{template_uuid}/	BiometricTemplatesRetrieveResponse

didit.blocklist

Method	HTTP	Returns	Notes
didit.blocklist.add(params: BlocklistAddParams)	POST /v3/blocklist/add/	BlocklistAddResponse
didit.blocklist.list(params?: BlocklistListParams)	GET /v3/blocklist/	page of BlocklistedItem
didit.blocklist.remove(params: BlocklistRemoveParams)	POST /v3/blocklist/remove/	BlocklistRemoveResponse

didit.businessSessions

Method	HTTP	Returns	Notes
didit.businessSessions.listNetworks(businessSessionId)	GET /v3/organization/{organization_id}/application/{application_id}/business-sessions/{business_session_id}/networks/	EntityNetworkMembershipList	application scoped

didit.businesses

Method	HTTP	Returns	Notes
didit.businesses.batchDelete(params?: BusinessesBatchDeleteParams)	POST /v3/businesses/delete/	BusinessesBatchDeleteResponse
didit.businesses.create(params?: BusinessesCreateParams)	POST /v3/businesses/create/	BusinessDetailItem
didit.businesses.generateSessionPdf(businessSessionId)	GET /v3/organization/{organization_id}/application/{application_id}/businesses/{business_session_id}/pdf/	Blob	application scoped
didit.businesses.list(params?: BusinessesListParams)	GET /v3/businesses/	page of BusinessListItem
didit.businesses.listNetworks(vendorBusinessUuid)	GET /v3/organization/{organization_id}/application/{application_id}/businesses/{vendor_business_uuid}/networks/	EntityNetworkMembershipList	application scoped
didit.businesses.retrieve(vendorData)	GET /v3/businesses/{vendor_data}/	BusinessDetailItem
didit.businesses.retrieveOngoingMonitoringJob(jobId)	GET /v3/organization/{organization_id}/application/{application_id}/vendor-businesses/toggle-ongoing-monitoring/{job_id}/	OngoingMonitoringJob	application scoped
didit.businesses.retrieveSessionOngoingMonitoringJob(jobId)	GET /v3/organization/{organization_id}/application/{application_id}/businesses/toggle-ongoing-monitoring/{job_id}/	OngoingMonitoringJob	application scoped
didit.businesses.setAmlMonitoring(params: BusinessesSetAmlMonitoringParams)	POST /v3/businesses/aml-monitoring/	AMLMonitoringToggleResult | AMLMonitoringJob
didit.businesses.setOngoingMonitoring(params: BusinessesSetOngoingMonitoringParams)	PATCH /v3/organization/{organization_id}/application/{application_id}/vendor-businesses/toggle-ongoing-monitoring/	OngoingMonitoringToggleResult | OngoingMonitoringJob	application scoped
didit.businesses.setSessionOngoingMonitoring(params: BusinessesSetSessionOngoingMonitoringParams)	PATCH /v3/organization/{organization_id}/application/{application_id}/businesses/toggle-ongoing-monitoring/	OngoingMonitoringToggleResult | OngoingMonitoringJob	application scoped
didit.businesses.update(vendorData, params?: BusinessesUpdateParams)	PATCH /v3/businesses/{vendor_data}/	BusinessDetailItem
didit.businesses.updateStatus(vendorData, params: BusinessesUpdateStatusParams)	PATCH /v3/businesses/{vendor_data}/update-status/	BusinessDetailItem

didit.cases

Method	HTTP	Returns	Notes
didit.cases.applyEntityAction(caseUuid, params: CasesApplyEntityActionParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/entity-actions/	CaseActionCaseEntityActionResult	application scoped
didit.cases.approveResolution(caseUuid)	POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/approve/	CaseDetail	application scoped
didit.cases.assign(caseUuid, params: CasesAssignParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/assign/	CaseDetail	application scoped
didit.cases.bulkAssign(params: CasesBulkAssignParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/bulk/assign/	CaseBulkUpdateResult	application scoped
didit.cases.bulkUpdateStatus(params: CasesBulkUpdateStatusParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/bulk/status/	CaseBulkUpdateResult	application scoped
didit.cases.create(params: CasesCreateParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/	CaseDetail	application scoped
didit.cases.delete(caseUuid)	DELETE /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/	nothing	application scoped
didit.cases.escalate(caseUuid)	POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/escalate/	CaseDetail	application scoped
didit.cases.findDuplicates(params?: CasesFindDuplicatesParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/duplicates/	CaseDuplicateCaseDuplicatePage	application scoped
didit.cases.list(params?: CasesListParams)	GET /v3/organization/{organization_id}/application/{application_id}/cases/	page of CaseListItem	application scoped
didit.cases.listActionReceipts(caseUuid, params?: CasesListActionReceiptsParams)	GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/action-receipts/	CaseActionCaseActionReceiptPage	application scoped
didit.cases.listAmlHits(caseUuid)	GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/aml/	AMLScreening[]	application scoped
didit.cases.listEvents(caseUuid, params?: CasesListEventsParams)	GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/events/	page of CaseEvent	application scoped
didit.cases.listReviewers()	GET /v3/organization/{organization_id}/application/{application_id}/cases/reviewers/	CasesListReviewersResponse	application scoped
didit.cases.print(caseUuid)	GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/print/	CasesPrintResponse	application scoped
didit.cases.rejectResolution(caseUuid, params?: CasesRejectResolutionParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/reject-approval/	CaseDetail	application scoped
didit.cases.reopen(caseUuid)	POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/reopen/	CaseDetail	application scoped
didit.cases.requestInfo(caseUuid)	POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/request-info/	CaseDetail	application scoped
didit.cases.resolve(caseUuid, params: CasesResolveParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/resolve/	CaseDetail	application scoped
didit.cases.retrieve(caseUuid)	GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/	CaseDetail	application scoped
didit.cases.retrieveStatistics(params?: CasesRetrieveStatisticsParams)	GET /v3/organization/{organization_id}/application/{application_id}/cases/statistics/	CasesRetrieveStatisticsResponse	application scoped
didit.cases.retryActionReceipt(caseUuid, receiptUuid)	POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/action-receipts/{receipt_uuid}/retry/	CaseActionCaseActionReceipt	application scoped
didit.cases.transfer(caseUuid, params: CasesTransferParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/transfer/	CaseDetail	application scoped
didit.cases.update(caseUuid, params?: CasesUpdateParams)	PATCH /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/	CaseDetail	application scoped

didit.cases.blueprints

Method	HTTP	Returns	Notes
didit.cases.blueprints.create(params: CasesBlueprintsCreateParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/	CaseBlueprintDetail	application scoped
didit.cases.blueprints.delete(blueprintUuid)	DELETE /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/	nothing	application scoped
didit.cases.blueprints.discardDraft(blueprintUuid, params: CasesBlueprintsDiscardDraftParams)	DELETE /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/draft/	nothing	application scoped
didit.cases.blueprints.installPresets(params?: CasesBlueprintsInstallPresetsParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/presets/install/	CaseBlueprintPresetInstallResult	application scoped
didit.cases.blueprints.list(params?: CasesBlueprintsListParams)	GET /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/	page of CaseBlueprintListItem	application scoped
didit.cases.blueprints.listHistory(blueprintUuid, params?: CasesBlueprintsListHistoryParams)	GET /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/history/	page of CasePublicationPolicyRevision	application scoped
didit.cases.blueprints.listPresets()	GET /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/presets/	CasesBlueprintsListPresetsResponse	application scoped
didit.cases.blueprints.publish(blueprintUuid, params: CasesBlueprintsPublishParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/publish/	CasePublicationCaseBlueprint	application scoped
didit.cases.blueprints.retrieve(blueprintUuid)	GET /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/	CaseBlueprintDetail	application scoped
didit.cases.blueprints.retrieveDraft(blueprintUuid)	GET /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/draft/	CasePublicationPolicyDraftResponse	application scoped
didit.cases.blueprints.saveDraft(blueprintUuid, params: CasesBlueprintsSaveDraftParams)	PUT /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/draft/	CasePublicationPolicyDraft	application scoped
didit.cases.blueprints.update(blueprintUuid, params?: CasesBlueprintsUpdateParams)	PATCH /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/	CaseBlueprintDetail	application scoped

didit.cases.checklist

Method	HTTP	Returns	Notes
didit.cases.checklist.list(caseUuid)	GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/checklist/	CaseChecklistItem[]	application scoped
didit.cases.checklist.toggleItem(caseUuid, itemUuid, params: CasesChecklistToggleItemParams)	PATCH /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/checklist/{item_uuid}/	CaseChecklistItem	application scoped

didit.cases.links

Method	HTTP	Returns	Notes
didit.cases.links.create(caseUuid, params: CasesLinksCreateParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/links/	CaseLink	application scoped
didit.cases.links.delete(caseUuid, linkUuid)	DELETE /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/links/{link_uuid}/	nothing	application scoped
didit.cases.links.list(caseUuid)	GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/links/	CaseLink[]	application scoped

didit.cases.notes

Method	HTTP	Returns	Notes
didit.cases.notes.create(caseUuid, params: CasesNotesCreateParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/	CaseCollaborationCaseNote	application scoped
didit.cases.notes.createAttachmentUpload(caseUuid, params: CasesNotesCreateAttachmentUploadParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/presign/	CasesNotesCreateAttachmentUploadResponse	application scoped, upload
didit.cases.notes.delete(caseUuid, noteUuid)	DELETE /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/{note_uuid}/	nothing	application scoped
didit.cases.notes.list(caseUuid, params?: CasesNotesListParams)	GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/	page of CaseCollaborationCaseNote	application scoped
didit.cases.notes.retrieveAttachmentUrl(caseUuid, params: CasesNotesRetrieveAttachmentUrlParams)	GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/presign/	CasesNotesRetrieveAttachmentUrlResponse	application scoped
didit.cases.notes.update(caseUuid, noteUuid, params?: CasesNotesUpdateParams)	PATCH /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/notes/{note_uuid}/	CaseCollaborationCaseNote	application scoped

didit.cases.regulatoryReports

Method	HTTP	Returns	Notes
didit.cases.regulatoryReports.create(caseUuid, params?: CasesRegulatoryReportsCreateParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/	RegulatoryReportDetail	application scoped
didit.cases.regulatoryReports.list(caseUuid, params?: CasesRegulatoryReportsListParams)	GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/regulatory-reports/	page of RegulatoryReportDetail	application scoped

didit.cases.requests

Method	HTTP	Returns	Notes
didit.cases.requests.cancel(caseUuid, requestUuid)	POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/{request_uuid}/cancel/	CustomerMessagingCaseRequest	application scoped
didit.cases.requests.create(caseUuid, params: CasesRequestsCreateParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/	CustomerMessagingCaseRequest	application scoped
didit.cases.requests.list(caseUuid, params?: CasesRequestsListParams)	GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/	page of CustomerMessagingCaseRequest	application scoped
didit.cases.requests.preview(caseUuid, params: CasesRequestsPreviewParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/preview/	CustomerMessagingCaseRequestPreviewResponse	application scoped
didit.cases.requests.remind(caseUuid, requestUuid)	POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/{request_uuid}/remind/	CasesRequestsRemindResponse	application scoped
didit.cases.requests.retrieveAttachment(caseUuid, requestUuid)	GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/{request_uuid}/attachment/	Blob	application scoped
didit.cases.requests.retrieveOptions(caseUuid)	GET /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/requests/options/	CustomerMessagingCaseRequestOptions	application scoped

didit.cases.routingRules

Method	HTTP	Returns	Notes
didit.cases.routingRules.create(params: CasesRoutingRulesCreateParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/	CaseRoutingRule	application scoped
didit.cases.routingRules.discardDraft(recordUuid, params: CasesRoutingRulesDiscardDraftParams)	DELETE /v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/draft/	nothing	application scoped
didit.cases.routingRules.list(params?: CasesRoutingRulesListParams)	GET /v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/	page of CaseRoutingRule	application scoped
didit.cases.routingRules.listHistory(recordUuid, params?: CasesRoutingRulesListHistoryParams)	GET /v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/history/	page of RoutingPublicationPolicyRevision	application scoped
didit.cases.routingRules.preview(params: CasesRoutingRulesPreviewParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/preview/	CaseRoutingPreview	application scoped
didit.cases.routingRules.publish(recordUuid, params: CasesRoutingRulesPublishParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/publish/	RoutingPublicationCaseRoutingRule	application scoped
didit.cases.routingRules.retrieve(recordUuid)	GET /v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/	CaseRoutingRule	application scoped
didit.cases.routingRules.retrieveDraft(recordUuid)	GET /v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/draft/	RoutingPublicationPolicyDraftResponse	application scoped
didit.cases.routingRules.saveDraft(recordUuid, params: CasesRoutingRulesSaveDraftParams)	PUT /v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/draft/	RoutingPublicationPolicyDraft	application scoped
didit.cases.routingRules.update(recordUuid, params?: CasesRoutingRulesUpdateParams)	PATCH /v3/organization/{organization_id}/application/{application_id}/cases/routing-rules/{record_uuid}/	CaseRoutingRule	application scoped

didit.cases.teams

Method	HTTP	Returns	Notes
didit.cases.teams.create(params: CasesTeamsCreateParams)	POST /v3/organization/{organization_id}/application/{application_id}/cases/teams/	CaseReviewTeam	application scoped
didit.cases.teams.list(params?: CasesTeamsListParams)	GET /v3/organization/{organization_id}/application/{application_id}/cases/teams/	page of CaseReviewTeam	application scoped
didit.cases.teams.retrieve(recordUuid)	GET /v3/organization/{organization_id}/application/{application_id}/cases/teams/{record_uuid}/	CaseReviewTeam	application scoped
didit.cases.teams.update(recordUuid, params?: CasesTeamsUpdateParams)	PATCH /v3/organization/{organization_id}/application/{application_id}/cases/teams/{record_uuid}/	CaseReviewTeam	application scoped

didit.customization

Method	HTTP	Returns	Notes
didit.customization.retrieve()	GET /v3/customization/	BrandingCustomization
didit.customization.update(params?: CustomizationUpdateParams)	PATCH /v3/customization/	BrandingCustomization	upload

didit.databaseValidation

Method	HTTP	Returns	Notes
didit.databaseValidation.validate(params: DatabaseValidationValidateParams)	POST /v3/database-validation/	DatabaseValidationValidateResponse	upload

didit.documentAi

Method	HTTP	Returns	Notes
didit.documentAi.analyze(params: DocumentAiAnalyzeParams)	POST /v3/document-ai/	DocumentAiAnalyzeResponse	upload

didit.email

Method	HTTP	Returns	Notes
didit.email.assessRisk(params: EmailAssessRiskParams)	POST /v3/email/risk/	EmailRiskResponse
didit.email.checkCode(params: EmailCheckCodeParams)	POST /v3/email/check/	EmailVerificationCheckResponse
didit.email.sendCode(params: EmailSendCodeParams)	POST /v3/email/send/	EmailVerificationSendResponse

didit.faceMatch

Method	HTTP	Returns	Notes
didit.faceMatch.compare(params: FaceMatchCompareParams)	POST /v3/face-match/	FaceMatchCompareResponse	upload

didit.faceSearch

Method	HTTP	Returns	Notes
didit.faceSearch.search(params: FaceSearchSearchParams)	POST /v3/face-search/	FaceSearchSearchResponse	upload

didit.fraudChecks

Method	HTTP	Returns	Notes
didit.fraudChecks.create(params: FraudChecksCreateParams)	POST /v3/fraud/checks/	FraudCheckResponse
didit.fraudChecks.plan(params: FraudChecksPlanParams)	POST /v3/fraud/checks/plan/	FraudCheckPlan
didit.fraudChecks.retrieve(checkId)	GET /v3/fraud/checks/{check_id}/	FraudCheckResponse

didit.idVerification

Method	HTTP	Returns	Notes
didit.idVerification.verify(params: IdVerificationVerifyParams)	POST /v3/id-verification/	IdVerificationVerifyResponse	upload

didit.idWallets

Method	HTTP	Returns	Notes
didit.idWallets.cancelVerification(requestId)	POST /v3/id-verification/wallets/verifications/{request_id}/cancel/	DigitalIdWalletApiWalletVerificationResponse
didit.idWallets.list()	GET /v3/id-verification/wallets/	DigitalIdWalletApiWalletCatalogResponse
didit.idWallets.pollVerification(requestId)	POST /v3/id-verification/wallets/verifications/{request_id}/poll/	DigitalIdWalletApiWalletVerificationResponse
didit.idWallets.retrieveVerification(requestId)	GET /v3/id-verification/wallets/verifications/{request_id}/	DigitalIdWalletApiWalletVerificationResponse
didit.idWallets.startAudkenni(params: IdWalletsStartAudkenniParams)	POST /v3/id-verification/wallets/audkenni/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startBankidCz(params: IdWalletsStartBankidCzParams)	POST /v3/id-verification/wallets/bankid-cz/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startBankidNo(params: IdWalletsStartBankidNoParams)	POST /v3/id-verification/wallets/bankid-no/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startBankidSe(params: IdWalletsStartBankidSeParams)	POST /v3/id-verification/wallets/bankid-se/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startBuypass(params: IdWalletsStartBuypassParams)	POST /v3/id-verification/wallets/buypass/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startConnectid(params: IdWalletsStartConnectidParams)	POST /v3/id-verification/wallets/connectid/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startDiia(params: IdWalletsStartDiiaParams)	POST /v3/id-verification/wallets/diia/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startEparakstsMobile(params: IdWalletsStartEparakstsMobileParams)	POST /v3/id-verification/wallets/eparaksts-mobile/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startEudi(params: IdWalletsStartEudiParams)	POST /v3/id-verification/wallets/eudi/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startFranceconnect(params: IdWalletsStartFranceconnectParams)	POST /v3/id-verification/wallets/franceconnect/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startFrejaid(params: IdWalletsStartFrejaidParams)	POST /v3/id-verification/wallets/frejaid/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startFtn(params: IdWalletsStartFtnParams)	POST /v3/id-verification/wallets/ftn/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startGovbr(params: IdWalletsStartGovbrParams)	POST /v3/id-verification/wallets/govbr/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startGovukWallet(params: IdWalletsStartGovukWalletParams)	POST /v3/id-verification/wallets/govuk-wallet/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startIdcardEe(params: IdWalletsStartIdcardEeParams)	POST /v3/id-verification/wallets/idcard-ee/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startIdin(params: IdWalletsStartIdinParams)	POST /v3/id-verification/wallets/idin/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startItsme(params: IdWalletsStartItsmeParams)	POST /v3/id-verification/wallets/itsme/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startMitid(params: IdWalletsStartMitidParams)	POST /v3/id-verification/wallets/mitid/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startMobileId(params: IdWalletsStartMobileIdParams)	POST /v3/id-verification/wallets/mobile-id/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startMojeid(params: IdWalletsStartMojeidParams)	POST /v3/id-verification/wallets/mojeid/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startOneid(params: IdWalletsStartOneidParams)	POST /v3/id-verification/wallets/oneid/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startPersonalausweis(params: IdWalletsStartPersonalausweisParams)	POST /v3/id-verification/wallets/personalausweis/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startSmartId(params: IdWalletsStartSmartIdParams)	POST /v3/id-verification/wallets/smart-id/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startUaePass(params: IdWalletsStartUaePassParams)	POST /v3/id-verification/wallets/uae-pass/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey
didit.idWallets.startVipps(params: IdWalletsStartVippsParams)	POST /v3/id-verification/wallets/vipps/	DigitalIdWalletApiWalletVerificationResponse	idempotencyKey

didit.investigator

Method	HTTP	Returns	Notes
didit.investigator.acceptRun(runId, params?: InvestigatorAcceptRunParams)	POST /v3/investigator/runs/{run_id}/accept/	InvestigatorDecision
didit.investigator.batchAcceptRuns(params: InvestigatorBatchAcceptRunsParams)	POST /v3/investigator/runs/batch-accept/	InvestigatorBatchAcceptResponse
didit.investigator.exportActivity(params?: InvestigatorExportActivityParams)	GET /v3/investigator/activity/export/	Blob
didit.investigator.listActivity(params?: InvestigatorListActivityParams)	GET /v3/investigator/activity/	page of Record<string, unknown>
didit.investigator.listGuardrails()	GET /v3/investigator/guardrails/	InvestigatorListGuardrailsResponse
didit.investigator.listQueue(params?: InvestigatorListQueueParams)	GET /v3/investigator/queue/	page of InvestigatorQueueRow
didit.investigator.overrideRun(runId, params: InvestigatorOverrideRunParams)	POST /v3/investigator/runs/{run_id}/override/	InvestigatorDecision
didit.investigator.retrieveDashboard(params?: InvestigatorRetrieveDashboardParams)	GET /v3/investigator/dashboard/	InvestigatorRetrieveDashboardResponse
didit.investigator.retrievePerformance(params?: InvestigatorRetrievePerformanceParams)	GET /v3/investigator/performance/	InvestigatorRetrievePerformanceResponse
didit.investigator.retrieveRun(runId)	GET /v3/investigator/runs/{run_id}/	InvestigatorRunDetail
didit.investigator.retrieveSettings()	GET /v3/investigator/settings/	InvestigatorSettings
didit.investigator.retrieveSummary(params?: InvestigatorRetrieveSummaryParams)	GET /v3/investigator/summary/	InvestigatorRetrieveSummaryResponse
didit.investigator.retrieveTransaction(transactionId)	GET /v3/investigator/transactions/{transaction_id}/	InvestigatorRetrieveTransactionResponse
didit.investigator.updateSettings(params?: InvestigatorUpdateSettingsParams)	PATCH /v3/investigator/settings/	InvestigatorSettings

didit.ip

Method	HTTP	Returns	Notes
didit.ip.assessRisk(params: IpAssessRiskParams)	POST /v3/ip/risk/	IPRiskResponse

didit.kyb

Method	HTTP	Returns	Notes
didit.kyb.listShareholders(params: KybListShareholdersParams)	POST /v3/kyb/shareholders/	KybListShareholdersResponse | KybListShareholdersResponse202
didit.kyb.listUbos(params: KybListUbosParams)	POST /v3/kyb/ubo/	KybListUbosResponse | KybListUbosResponse202
didit.kyb.search(params: KybSearchParams)	POST /v3/kyb/search/	KybSearchResponse
didit.kyb.select(params: KybSelectParams)	POST /v3/kyb/select/	KybSelectResponse

didit.lists

Method	HTTP	Returns	Notes
didit.lists.create(params: ListsCreateParams)	POST /v3/lists/	ComplianceList
didit.lists.delete(listUuid)	DELETE /v3/lists/{list_uuid}/	nothing
didit.lists.list(params?: ListsListParams)	GET /v3/lists/	page of ComplianceList
didit.lists.retrieve(listUuid)	GET /v3/lists/{list_uuid}/	ComplianceList
didit.lists.update(listUuid, params?: ListsUpdateParams)	PATCH /v3/lists/{list_uuid}/	ListsUpdateResponse

didit.lists.entries

Method	HTTP	Returns	Notes
didit.lists.entries.create(listUuid, params?: ListsEntriesCreateParams)	POST /v3/lists/{list_uuid}/entries/	ComplianceListEntry
didit.lists.entries.delete(listUuid, entryUuid)	DELETE /v3/lists/{list_uuid}/entries/{entry_uuid}/	nothing
didit.lists.entries.list(listUuid, params?: ListsEntriesListParams)	GET /v3/lists/{list_uuid}/entries/	page of ComplianceListEntry
didit.lists.entries.uploadFace(listUuid, params: ListsEntriesUploadFaceParams)	POST /v3/lists/{list_uuid}/entries/face-upload/	ComplianceListEntry

didit.monitoringEvents

Method	HTTP	Returns	Notes
didit.monitoringEvents.create(params: MonitoringEventsCreateParams)	POST /v3/events/	MonitoringEventIngestResult
didit.monitoringEvents.createBatch(params: MonitoringEventsCreateBatchParams)	POST /v3/events/batch/	MonitoringEventsCreateBatchResponse
didit.monitoringEvents.createSdkToken(params: MonitoringEventsCreateSdkTokenParams)	POST /v3/events/sdk-token/	MonitoringEventsCreateSdkTokenResponse
didit.monitoringEvents.delete(eventUuid)	DELETE /v3/events/{event_uuid}/delete/	nothing
didit.monitoringEvents.list(params?: MonitoringEventsListParams)	GET /v3/events/	page of MonitoringEvent
didit.monitoringEvents.retrieve(eventUuid)	GET /v3/events/{event_uuid}/	MonitoringEventDetail
didit.monitoringEvents.retrieveEnrichmentMetrics(params?: MonitoringEventsRetrieveEnrichmentMetricsParams)	GET /v3/events/enrichment-metrics/	MonitoringEventsRetrieveEnrichmentMetricsResponse
didit.monitoringEvents.retrieveSubjectTimeline(vendorData, params?: MonitoringEventsRetrieveSubjectTimelineParams)	GET /v3/events/subjects/{vendor_data}/	page of MonitoringEvent

didit.networks

Method	HTTP	Returns	Notes
didit.networks.addTag(networkUuid, params: NetworksAddTagParams)	POST /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/add/	NetworkDetailResponse	application scoped
didit.networks.downloadReport(networkUuid)	GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/report/	Blob	application scoped
didit.networks.list(params?: NetworksListParams)	GET /v3/organization/{organization_id}/application/{application_id}/networks/	page of NetworkListItem	application scoped
didit.networks.listMembers(networkUuid)	GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/members/	NetworksListMembersResponse	application scoped
didit.networks.listSignals(networkUuid)	GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/signals/	NetworksListSignalsResponse	application scoped
didit.networks.removeTag(networkUuid, params: NetworksRemoveTagParams)	POST /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/tags/remove/	NetworkDetailResponse	application scoped
didit.networks.retrieve(networkUuid)	GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/	NetworkDetailResponse	application scoped
didit.networks.retrieveGraph(networkUuid, params?: NetworksRetrieveGraphParams)	GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/graph/	NetworkGraph	application scoped
didit.networks.retrieveMap(networkUuid)	GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/map/	NetworkMap	application scoped
didit.networks.retrieveTimeline(networkUuid, params?: NetworksRetrieveTimelineParams)	GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/timeline/	NetworkTimeline | NetworkTimelinePage	application scoped

didit.networks.notes

Method	HTTP	Returns	Notes
didit.networks.notes.create(networkUuid, params: NetworksNotesCreateParams)	POST /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/notes/	NetworkNote	application scoped
didit.networks.notes.delete(networkUuid, noteUuid)	DELETE /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/notes/{note_uuid}/	nothing	application scoped
didit.networks.notes.list(networkUuid, params?: NetworksNotesListParams)	GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/notes/	page of NetworkNote	application scoped

didit.passiveLiveness

Method	HTTP	Returns	Notes
didit.passiveLiveness.check(params: PassiveLivenessCheckParams)	POST /v3/passive-liveness/	PassiveLivenessCheckResponse	upload

didit.phone

Method	HTTP	Returns	Notes
didit.phone.assessRisk(params: PhoneAssessRiskParams)	POST /v3/phone/risk/	PhoneRiskResponse
didit.phone.checkCode(params: PhoneCheckCodeParams)	POST /v3/phone/check/	PhoneVerificationCheckResponse
didit.phone.sendCode(params: PhoneSendCodeParams)	POST /v3/phone/send/	PhoneVerificationSendResponse

didit.pricing

Method	HTTP	Returns	Notes
didit.pricing.bankVerification()	GET /v3/organization/bank-verification-pricing/	BankVerificationPricing

didit.proofOfAddress

Method	HTTP	Returns	Notes
didit.proofOfAddress.verify(params: ProofOfAddressVerifyParams)	POST /v3/poa/	ProofOfAddressVerifyResponse	upload

didit.questionnaires

Method	HTTP	Returns	Notes
didit.questionnaires.create(params: QuestionnairesCreateParams)	POST /v3/questionnaires/	QuestionnaireDetail
didit.questionnaires.delete(questionnaireUuid)	DELETE /v3/questionnaires/{questionnaire_uuid}/	nothing
didit.questionnaires.list(params?: QuestionnairesListParams)	GET /v3/questionnaires/	page of QuestionnaireListItem
didit.questionnaires.retrieve(questionnaireUuid)	GET /v3/questionnaires/{questionnaire_uuid}/	QuestionnaireDetail
didit.questionnaires.update(questionnaireUuid, params?: QuestionnairesUpdateParams)	PATCH /v3/questionnaires/{questionnaire_uuid}/	QuestionnaireDetail

didit.regulatoryReports

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, 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
didit.regulatoryReports.retrieveDownloadUrl(reportUuid, params?: RegulatoryReportsRetrieveDownloadUrlParams)	GET /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/download-url/	RegulatoryReportsRetrieveDownloadUrlResponse	application scoped
didit.regulatoryReports.update(reportUuid, params?: RegulatoryReportsUpdateParams)	PATCH /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/	RegulatoryReportDetail	application scoped
didit.regulatoryReports.validate(reportUuid)	POST /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/validate/	RegulatoryReportsValidateResponse	application scoped

didit.reportTemplates

Method	HTTP	Returns	Notes
didit.reportTemplates.create(params: ReportTemplatesCreateParams)	POST /v3/organization/{organization_id}/application/{application_id}/report-templates/	ReportTemplateDetail	application scoped
didit.reportTemplates.delete(templateUuid)	DELETE /v3/organization/{organization_id}/application/{application_id}/report-templates/{template_uuid}/	nothing	application scoped
didit.reportTemplates.list(params?: ReportTemplatesListParams)	GET /v3/organization/{organization_id}/application/{application_id}/report-templates/	page of ReportTemplateDetail	application scoped
didit.reportTemplates.retrieve(templateUuid)	GET /v3/organization/{organization_id}/application/{application_id}/report-templates/{template_uuid}/	ReportTemplateDetail	application scoped
didit.reportTemplates.update(templateUuid, params?: ReportTemplatesUpdateParams)	PATCH /v3/organization/{organization_id}/application/{application_id}/report-templates/{template_uuid}/	ReportTemplateDetail	application scoped

didit.sessions

Method	HTTP	Returns	Notes
didit.sessions.addImages(sessionId, params: SessionsAddImagesParams)	PATCH /v3/session/{sessionId}/add-images/	SessionsAddImagesResponse	upload
didit.sessions.batchDelete(params?: SessionsBatchDeleteParams)	POST /v3/sessions/delete/	SessionsBatchDeleteResponse | SessionDeletionJob
didit.sessions.bulkUpdateAmlHitStatus(sessionId, params: SessionsBulkUpdateAmlHitStatusParams)	PATCH /v3/session/{sessionId}/bulk-update-aml-hit-status/	SessionsBulkUpdateAmlHitStatusResponse
didit.sessions.cancelFeatureOverride(sessionId, overrideId)	POST /v3/session/{sessionId}/features/overrides/{overrideId}/cancel/	FeatureStatusOverride
didit.sessions.create(params: SessionsCreateParams)	POST /v3/session/	SessionsCreateResponse
didit.sessions.delete(sessionId, params?: SessionsDeleteParams)	DELETE /v3/session/{sessionId}/delete/	SessionsDeleteResponse
didit.sessions.exportAmlScreeningHistory(sessionId, params?: SessionsExportAmlScreeningHistoryParams)	GET /v3/session/{sessionId}/aml-screening-history/export/	Blob
didit.sessions.generatePdf(sessionId)	GET /v3/session/{sessionId}/generate-pdf/	Blob
didit.sessions.importShared(params: SessionsImportSharedParams)	POST /v3/session/import-shared/	SessionDecision
didit.sessions.list(params?: SessionsListParams)	GET /v3/sessions/	page of UserSessionListItem | BusinessSessionListItem
didit.sessions.listAmlScreeningHistory(sessionId, params?: SessionsListAmlScreeningHistoryParams)	GET /v3/session/{sessionId}/aml-screening-history/	page of AMLScreeningRun
didit.sessions.listEvents(sessionId, params?: SessionsListEventsParams)	GET /v3/session/{sessionId}/events/	page of SessionEvent
didit.sessions.listFeatureOverrides(sessionId)	GET /v3/session/{sessionId}/features/overrides/	SessionsListFeatureOverridesResponse
didit.sessions.listNetworks(sessionId)	GET /v3/organization/{organization_id}/application/{application_id}/sessions/{session_id}/networks/	EntityNetworkMembershipList	application scoped
didit.sessions.previewDecisionEmail(sessionId, params: SessionsPreviewDecisionEmailParams)	POST /v3/session/{sessionId}/decision-email-preview/	SessionsPreviewDecisionEmailResponse
didit.sessions.previewResubmission(sessionId, params?: SessionsPreviewResubmissionParams)	POST /v3/session/{sessionId}/resubmission-preview/	SessionsPreviewResubmissionResponse
didit.sessions.regenerateKybParty(sessionId, partyUuid)	POST /v3/session/{sessionId}/kyb/parties/{partyUuid}/regenerate/	KYBKeyPeopleParty
didit.sessions.retrieveDecision(sessionId, params?: SessionsRetrieveDecisionParams)	GET /v3/session/{sessionId}/decision/	SessionDecision
didit.sessions.retrieveDeletionJob(jobId)	GET /v3/sessions/delete/{job_id}/	SessionDeletionJob
didit.sessions.share(sessionId, params: SessionsShareParams)	POST /v3/session/{sessionId}/share/	SessionsShareResponse
didit.sessions.simulate(sessionId, params?: SessionsSimulateParams)	POST /v3/session/{sessionId}/simulate/	SandboxSimulateResponse
didit.sessions.updateAmlHitStatus(sessionId, params: SessionsUpdateAmlHitStatusParams)	PATCH /v3/session/{sessionId}/update-aml-hit-status/	SessionsUpdateAmlHitStatusResponse
didit.sessions.updateAmlStatus(sessionId, params: SessionsUpdateAmlStatusParams)	PATCH /v3/session/{sessionId}/update-aml-status/	SessionsUpdateAmlStatusResponse
didit.sessions.updateData(sessionId, params?: SessionsUpdateDataParams)	PATCH /v3/session/{sessionId}/update-data/	SessionsUpdateDataResponse
didit.sessions.updateDocumentAiData(sessionId, documentUuid, params?: SessionsUpdateDocumentAiDataParams)	PATCH /v3/document-ai/{sessionId}/documents/{documentUuid}/	SessionsUpdateDocumentAiDataResponse
didit.sessions.updateFeatureStatus(sessionId, nodeId, params: SessionsUpdateFeatureStatusParams)	PATCH /v3/session/{sessionId}/features/{nodeId}/update-status/	SessionsUpdateFeatureStatusResponse
didit.sessions.updateKybCompanyData(sessionId, companyUuid, params?: SessionsUpdateKybCompanyDataParams)	PATCH /v3/session/{sessionId}/kyb/{companyUuid}/update-data/	SessionsUpdateKybCompanyDataResponse
didit.sessions.updateKybParty(sessionId, partyUuid, params: SessionsUpdateKybPartyParams)	PATCH /v3/session/{sessionId}/kyb/parties/{partyUuid}/	SessionsUpdateKybPartyResponse
didit.sessions.updatePoaData(sessionId, params?: SessionsUpdatePoaDataParams)	PATCH /v3/session/{sessionId}/update-poa-data/	SessionsUpdatePoaDataResponse
didit.sessions.updateStatus(sessionId, params: SessionsUpdateStatusParams)	PATCH /v3/session/{sessionId}/update-status/	SessionsUpdateStatusResponse

didit.sessions.imports

Method	HTTP	Returns	Notes
didit.sessions.imports.cancel(importId)	POST /v3/session/imports/{importId}/cancel/	SessionImportJob
didit.sessions.imports.checkProvider(params: SessionsImportsCheckProviderParams)	POST /v3/session/imports/providers/check/	SessionsImportsCheckProviderResponse
didit.sessions.imports.create(params?: SessionsImportsCreateParams)	POST /v3/session/imports/	SessionImportJob	upload
didit.sessions.imports.listActiveJobs()	GET /v3/import-jobs/active/	SessionsImportsListActiveJobsResponse
didit.sessions.imports.listErrors(importId, params?: SessionsImportsListErrorsParams)	GET /v3/session/imports/{importId}/errors/	page of SessionImportError
didit.sessions.imports.listJobs(params?: SessionsImportsListJobsParams)	GET /v3/import-jobs/	SessionsImportsListJobsResponse
didit.sessions.imports.listProviders()	GET /v3/session/imports/providers/	SessionsImportsListProvidersResponse
didit.sessions.imports.pause(importId)	POST /v3/session/imports/{importId}/pause/	SessionImportJob
didit.sessions.imports.resume(importId)	POST /v3/session/imports/{importId}/resume/	SessionImportJob
didit.sessions.imports.retrieve(importId)	GET /v3/session/imports/{importId}/	SessionImportJob
didit.sessions.imports.retrieveTemplate(params?: SessionsImportsRetrieveTemplateParams)	GET /v3/session/imports/template/	Blob
didit.sessions.imports.retry(importId, params?: SessionsImportsRetryParams)	POST /v3/session/imports/{importId}/retry/	SessionImportJob	upload
didit.sessions.imports.start(importId, params?: SessionsImportsStartParams)	POST /v3/session/imports/{importId}/start/	SessionImportJob

didit.sessions.reviews

Method	HTTP	Returns	Notes
didit.sessions.reviews.create(sessionId, params?: SessionsReviewsCreateParams)	POST /v3/sessions/{session_id}/reviews/	SessionsReviewsCreateResponse
didit.sessions.reviews.list(sessionId, params?: SessionsReviewsListParams)	GET /v3/sessions/{session_id}/reviews/	page of ReviewItem

didit.sessions.signatures

Method	HTTP	Returns	Notes
didit.sessions.signatures.downloadDocument(sessionId, nodeId, documentId)	GET /v3/session/{sessionId}/signatures/{nodeId}/documents/{documentId}/file/	Blob
didit.sessions.signatures.downloadEvidence(sessionId, nodeId, params?: SessionsSignaturesDownloadEvidenceParams)	GET /v3/session/{sessionId}/signatures/{nodeId}/evidence/	Blob
didit.sessions.signatures.downloadFieldImage(sessionId, nodeId, fieldId)	GET /v3/session/{sessionId}/signatures/{nodeId}/fields/{fieldId}/image/	Blob
didit.sessions.signatures.validate(sessionId, nodeId, params?: SessionsSignaturesValidateParams)	POST /v3/session/{sessionId}/signatures/{nodeId}/validate/	SessionsSignaturesValidateResponse

didit.sessions.webhooks

Method	HTTP	Returns	Notes
didit.sessions.webhooks.list(sessionId)	GET /v3/session/{sessionId}/webhooks/	SessionWebhookDelivery[]
didit.sessions.webhooks.resend(sessionId, webhookUuid)	POST /v3/session/{sessionId}/webhook/{webhook_uuid}/resend	SessionWebhookDelivery
didit.sessions.webhooks.retrieve(sessionId, webhookUuid)	GET /v3/session/{sessionId}/webhook/{webhook_uuid}	SessionWebhookDelivery

didit.transactions

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

Method	HTTP	Returns	Notes
didit.transactions.notes.create(transactionId, params: TransactionsNotesCreateParams)	POST /v3/transactions/{transaction_id}/notes/	TransactionNote
didit.transactions.notes.list(transactionId, params?: TransactionsNotesListParams)	GET /v3/transactions/{transaction_id}/notes/	page of TransactionNote

didit.transactions.rules

Method	HTTP	Returns	Notes
didit.transactions.rules.backtest(params?: TransactionsRulesBacktestParams)	POST /v3/transactions/rules/backtest/	TransactionRuleBacktestResult
didit.transactions.rules.create(params: TransactionsRulesCreateParams)	POST /v3/transactions/rules/	TransactionRuleDetail
didit.transactions.rules.delete(ruleUuid)	DELETE /v3/transactions/rules/{rule_uuid}/	nothing
didit.transactions.rules.installLibrary(params?: TransactionsRulesInstallLibraryParams)	POST /v3/transactions/rules/install/	TransactionRuleInstallResult
didit.transactions.rules.list(params?: TransactionsRulesListParams)	GET /v3/transactions/rules/	page of TransactionRuleDetail
didit.transactions.rules.listLibrary(params?: TransactionsRulesListLibraryParams)	GET /v3/transactions/rules/library/	page of TransactionRuleLibraryEntry
didit.transactions.rules.retrieve(ruleUuid)	GET /v3/transactions/rules/{rule_uuid}/	TransactionRuleDetail
didit.transactions.rules.uninstallLibrary(params?: TransactionsRulesUninstallLibraryParams)	DELETE /v3/transactions/rules/install/	TransactionRuleInstallResult
didit.transactions.rules.update(ruleUuid, params?: TransactionsRulesUpdateParams)	PATCH /v3/transactions/rules/{rule_uuid}/	TransactionRuleDetail

didit.transactions.travelRule

Method	HTTP	Returns	Notes
didit.transactions.travelRule.confirmOwnership(transactionId, params: TransactionsTravelRuleConfirmOwnershipParams)	POST /v3/transactions/{transaction_id}/travel-rule/ownership/	TravelRuleTransferDetail
didit.transactions.travelRule.createMessage(transactionId, params?: TransactionsTravelRuleCreateMessageParams)	POST /v3/transactions/{transaction_id}/travel-rule/messages/	TravelRuleMessage
didit.transactions.travelRule.listMessages(transactionId)	GET /v3/transactions/{transaction_id}/travel-rule/messages/	TravelRuleMessage[]
didit.transactions.travelRule.triggerTestVaspInbound(params: TransactionsTravelRuleTriggerTestVaspInboundParams)	POST /v3/travel-rule/test-vasp/inbound/	TravelRuleTestVaspInboundResponse
didit.transactions.travelRule.updateTransfer(transactionId, params?: TransactionsTravelRuleUpdateTransferParams)	PATCH /v3/transactions/{transaction_id}/travel-rule/	TravelRuleTransferDetail

didit.travelRule

Method	HTTP	Returns	Notes
didit.travelRule.clearVaspDecision(vaspId)	DELETE /v3/travel-rule/vasps/{vasp_id}/decision/	TravelRuleCounterpartyDecisionResponse
didit.travelRule.createWidgetSession(params?: TravelRuleCreateWidgetSessionParams)	POST /v3/travel-rule/widget-session/	TravelRuleWidgetSessionResponse
didit.travelRule.listVaspQuestionnaires(vaspId)	GET /v3/travel-rule/vasps/{vasp_id}/questionnaires/	TravelRuleCounterpartyQuestionnaireList
didit.travelRule.listVasps(params?: TravelRuleListVaspsParams)	GET /v3/travel-rule/vasps/	page of VaspDirectoryEntry
didit.travelRule.registerInbound(params: TravelRuleRegisterInboundParams)	POST /v3/travel-rule/inbound/	TravelRuleInboundResponse
didit.travelRule.retrieveSettings()	GET /v3/travel-rule/settings/	TravelRuleSettingsDetail
didit.travelRule.retrieveVasp(vaspId)	GET /v3/travel-rule/vasps/{vasp_id}/	VaspDirectoryEntry
didit.travelRule.retrieveVaspDecision(vaspId)	GET /v3/travel-rule/vasps/{vasp_id}/decision/	TravelRuleCounterpartyDecisionResponse
didit.travelRule.retrieveVaspScreening(vaspId)	GET /v3/travel-rule/vasps/{vasp_id}/screening/	TravelRuleCounterpartyScreeningStatus
didit.travelRule.screenVasp(vaspId, params?: TravelRuleScreenVaspParams)	POST /v3/travel-rule/vasps/{vasp_id}/screening/	TravelRuleCounterpartyScreeningResult
didit.travelRule.sendComplianceEmailConfirmation()	POST /v3/travel-rule/settings/compliance-email/confirmation/	TravelRuleSendComplianceEmailConfirmationResponse
didit.travelRule.sendVaspQuestionnaire(vaspId, params?: TravelRuleSendVaspQuestionnaireParams)	POST /v3/travel-rule/vasps/{vasp_id}/questionnaires/	TravelRuleCounterpartyQuestionnaire
didit.travelRule.updateSettings(params?: TravelRuleUpdateSettingsParams)	PUT /v3/travel-rule/settings/	TravelRuleSettingsDetail
didit.travelRule.updateVaspDecision(vaspId, params: TravelRuleUpdateVaspDecisionParams)	PUT /v3/travel-rule/vasps/{vasp_id}/decision/	TravelRuleCounterpartyDecisionResponse

didit.travelRule.counterpartyContacts

Method	HTTP	Returns	Notes
didit.travelRule.counterpartyContacts.create(params: TravelRuleCounterpartyContactsCreateParams)	POST /v3/travel-rule/counterparty-contacts/	TravelRuleCounterpartyContact
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
didit.travelRule.transfers.list(params?: TravelRuleTransfersListParams)	GET /v3/travel-rule/transfers/	page of TravelRuleTransferRow

didit.travelRule.walletAddresses

Method	HTTP	Returns	Notes
didit.travelRule.walletAddresses.bulkImport(params?: TravelRuleWalletAddressesBulkImportParams)	POST /v3/travel-rule/wallet-addresses/import/	WalletAddressImportReport	upload
didit.travelRule.walletAddresses.create(params: TravelRuleWalletAddressesCreateParams)	POST /v3/travel-rule/wallet-addresses/	WalletAddressEntry
didit.travelRule.walletAddresses.delete(entryUuid)	DELETE /v3/travel-rule/wallet-addresses/{entry_uuid}/	nothing
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
didit.travelRule.workspace.claim(params: TravelRuleWorkspaceClaimParams)	POST /v3/travel-rule/workspace/claim/	TravelRuleWorkspace
didit.travelRule.workspace.confirmDomain(params: TravelRuleWorkspaceConfirmDomainParams)	POST /v3/travel-rule/workspace/domain/confirm/	TravelRuleWorkspace
didit.travelRule.workspace.enableBilling(params?: TravelRuleWorkspaceEnableBillingParams)	POST /v3/travel-rule/workspace/billing/	TravelRuleWorkspace
didit.travelRule.workspace.get()	GET /v3/travel-rule/workspace/	TravelRuleWorkspace
didit.travelRule.workspace.sendDomainCode()	POST /v3/travel-rule/workspace/domain/code/	TravelRuleWorkspaceDomainCodeResponse
didit.travelRule.workspace.verifyDomainDns()	POST /v3/travel-rule/workspace/domain/dns/	TravelRuleWorkspace

didit.users

Method	HTTP	Returns	Notes
didit.users.batchDelete(params?: UsersBatchDeleteParams)	POST /v3/users/delete/	UsersBatchDeleteResponse
didit.users.create(params: UsersCreateParams)	POST /v3/users/create/	UsersCreateResponse
didit.users.generatePdf(vendorData)	GET /v3/users/{vendor_data}/generate-pdf/	Blob
didit.users.list(params?: UsersListParams)	GET /v3/users/	page of UserListItem
didit.users.listNetworks(vendorUserUuid)	GET /v3/organization/{organization_id}/application/{application_id}/users/{vendor_user_uuid}/networks/	EntityNetworkMembershipList	application scoped
didit.users.retrieve(vendorData)	GET /v3/users/{vendor_data}/	UserDetailItem
didit.users.retrieveOngoingMonitoringJob(jobId)	GET /v3/organization/{organization_id}/application/{application_id}/vendor-users/toggle-ongoing-monitoring/{job_id}/	OngoingMonitoringJob	application scoped
didit.users.setAmlMonitoring(params: UsersSetAmlMonitoringParams)	POST /v3/users/aml-monitoring/	AMLMonitoringToggleResult | AMLMonitoringJob
didit.users.setOngoingMonitoring(params: UsersSetOngoingMonitoringParams)	PATCH /v3/organization/{organization_id}/application/{application_id}/vendor-users/toggle-ongoing-monitoring/	OngoingMonitoringToggleResult | OngoingMonitoringJob	application scoped
didit.users.update(vendorData, params?: UsersUpdateParams)	PATCH /v3/users/{vendor_data}/	UserDetailItem
didit.users.updateStatus(vendorData, params: UsersUpdateStatusParams)	PATCH /v3/users/{vendor_data}/update-status/	UserDetailItem
didit.users.uploadFace(diditInternalId, params: UsersUploadFaceParams)	POST /v3/organization/{organization_id}/application/{application_id}/vendor-users/by-id/{didit_internal_id}/faces/upload/	UsersUploadFaceResponse	application scoped

didit.walletScreening

Method	HTTP	Returns	Notes
didit.walletScreening.screen(params: WalletScreeningScreenParams)	POST /v3/wallet-screening/	WalletScreeningResult
didit.walletScreening.screenPdf(params: WalletScreeningResult)	POST /v3/wallet-screening/pdf/	Blob

didit.webhooks

Method	HTTP	Returns	Notes
didit.webhooks.retrieveConfig()	GET /v3/webhook/	WebhookConfig
didit.webhooks.updateConfig(params?: WebhooksUpdateConfigParams)	PATCH /v3/webhook/	WebhookConfig

didit.webhooks.destinations

Method	HTTP	Returns	Notes
didit.webhooks.destinations.create(params: WebhooksDestinationsCreateParams)	POST /v3/webhook/destinations/	WebhooksDestinationsCreateResponse
didit.webhooks.destinations.delete(destinationUuid)	DELETE /v3/webhook/destinations/{destination_uuid}/	nothing
didit.webhooks.destinations.list()	GET /v3/webhook/destinations/	WebhooksDestinationsListResponse[]
didit.webhooks.destinations.listDeliveries(destinationUuid, params?: WebhooksDestinationsListDeliveriesParams)	GET /v3/webhook/destinations/{destination_uuid}/deliveries/	page of WebhookDestinationDelivery
didit.webhooks.destinations.resendDelivery(destinationUuid, deliveryUuid)	POST /v3/webhook/destinations/{destination_uuid}/deliveries/{delivery_uuid}/resend/	WebhookDestinationDeliveryDetail
didit.webhooks.destinations.retrieve(destinationUuid)	GET /v3/webhook/destinations/{destination_uuid}/	WebhooksDestinationsRetrieveResponse
didit.webhooks.destinations.retrieveAnalytics(destinationUuid, params?: WebhooksDestinationsRetrieveAnalyticsParams)	GET /v3/webhook/destinations/{destination_uuid}/analytics/	WebhooksDestinationsRetrieveAnalyticsResponse
didit.webhooks.destinations.retrieveDelivery(destinationUuid, deliveryUuid)	GET /v3/webhook/destinations/{destination_uuid}/deliveries/{delivery_uuid}/	WebhookDestinationDeliveryDetail
didit.webhooks.destinations.update(destinationUuid, params?: WebhooksDestinationsUpdateParams)	PATCH /v3/webhook/destinations/{destination_uuid}/	WebhooksDestinationsUpdateResponse

didit.workflows

Method	HTTP	Returns	Notes
didit.workflows.create(params: WorkflowsCreateParams)	POST /v3/workflows/	WorkflowDetail
didit.workflows.delete(settingsUuid)	DELETE /v3/workflows/{settings_uuid}/	nothing
didit.workflows.list(params?: WorkflowsListParams)	GET /v3/workflows/	page of WorkflowListItem
didit.workflows.retrieve(settingsUuid)	GET /v3/workflows/{settings_uuid}/	WorkflowDetail
didit.workflows.update(settingsUuid, params?: WorkflowsUpdateParams)	PATCH /v3/workflows/{settings_uuid}/	WorkflowDetail