@propxchain/core-client 0.2.1-canary.19 → 0.2.1-canary.21

package/src/canisters/document_verification/document_verification.did

@@ -1,98 +1,248 @@
-type VerificationMethod = 
- variant {
-   commercial_api: text;
-   dvla_api;
-   manual_solicitor;
-   passport_dcs;
-   system_hash_only;
- };
-type Time = int;
-type Result = 
- variant {
-   err: text;
-   ok: DocumentVerification;
- };
-type DocumentVerification = 
- record {
-   calculatedHash: text;
-   documentId: nat;
-   documentType: text;
-   expectedHash: text;
-   expiresAt: opt Time;
-   failureReason: opt text;
-   hashVerified: bool;
-   id: nat;
-   isValid: bool;
-   notes: opt text;
-   propertyId: nat;
-   verificationDate: Time;
-   verificationMethod: VerificationMethod;
-   verifiedBy: principal;
- };
-type DocumentMetadata = 
- record {
-   contentType: opt text;
-   documentHash: text;
-   documentType: text;
-   fileName: opt text;
-   fileSize: opt nat;
-   id: nat;
-   isVerified: bool;
-   lastVerificationId: opt nat;
-   propertyId: nat;
-   storageDocumentId: opt nat;
-   transactionId: opt nat;
-   uploadedAt: Time;
-   uploadedBy: principal;
- };
-type AuditLog = 
- record {
-   action: text;
-   details: text;
-   documentId: nat;
-   id: nat;
-   performedBy: principal;
-   success: bool;
-   timestamp: Time;
- };
-service : {
-  deleteDocument: (documentId: nat) -> (variant {
-                                          err: text;
-                                          ok;
-                                        });
-  getAuditLogs: () -> (vec AuditLog) query;
-  getConfiguration: () ->
-   (record {
-      documentStorage: opt principal;
-      userManagement: opt principal;
-    }) query;
-  getCycles: () -> (nat) query;
-  getDocument: (id: nat) -> (opt DocumentMetadata) query;
-  getDocumentVerifications: (documentId: nat) ->
-   (vec DocumentVerification) query;
-  getPropertyDocuments: (propertyId: nat) -> (vec DocumentMetadata) query;
-  getRecentAuditLogs: (limit: nat) -> (vec AuditLog) query;
-  getStats: () ->
-   (record {
-      totalAuditLogs: nat;
-      totalDocuments: nat;
-      totalVerifications: nat;
-      verifiedDocuments: nat;
-    }) query;
-  getUnverifiedDocuments: (propertyId: nat) -> (vec DocumentMetadata) query;
-  getVerification: (verificationId: nat) -> (opt DocumentVerification) query;
-  getVerificationsByVerifier: (verifier: principal) ->
-   (vec DocumentVerification) query;
-  registerDocument: (propertyId: nat, transactionId: opt nat, documentType:
-   text, documentHash: text, storageDocumentId: opt nat, fileName: opt text,
-   fileSize: opt nat, contentType: opt text) -> (nat);
-  setDocumentStorageCanister: (canisterId: principal) -> ();
-  setUserManagementCanister: (canisterId: principal) -> ();
-  verifyDocument: (documentId: nat) -> (bool);
-  verifyDocumentWithHash: (documentId: nat, notes: opt text) -> (Result);
-  verifyWithCommercialAPI: (_documentId: nat, _apiProvider: text,
-   _verificationData: text) -> (Result);
-  verifyWithDVLA: (_documentId: nat, _drivingLicenseNumber: text) -> (Result);
-  verifyWithPassportDCS: (_documentId: nat, _passportNumber: text) ->
-   (Result);
-}
+type VerificationMethod = 
+ variant {
+   commercial_api: text;
+   dvla_api;
+   manual_solicitor;
+   oscar_ai: OscarVerificationDetails;
+   passport_dcs;
+   system_hash_only;
+ };
+type TransactionVerificationSummary = 
+ record {
+   allDocumentsVerified: bool;
+   allLRDocumentsCurrent: bool;
+   daysUntilSearchExpiry: opt int;
+   expiredDocuments: nat;
+   hasOfficialSearch: bool;
+   lrDocuments: vec LRDocumentSummary;
+   missingDocuments: vec text;
+   officialSearchExpiry: opt int;
+   officialSearchValid: bool;
+   readyForCompletion: bool;
+   readyForExchange: bool;
+   readyForSubmission: bool;
+   titleNumber: text;
+   totalDocuments: nat;
+   transactionId: text;
+   unverifiedDocuments: nat;
+   verifiedDocuments: nat;
+ };
+type Time = int;
+type Result_4 = 
+ variant {
+   err: text;
+   ok: TransactionVerificationSummary;
+ };
+type Result_3 = 
+ variant {
+   err: text;
+   ok: nat;
+ };
+type Result_2 = 
+ variant {
+   err: text;
+   ok: OfficialCopyVerification;
+ };
+type Result_1 = 
+ variant {
+   err: text;
+   ok: OSCertificateVerification;
+ };
+type Result = 
+ variant {
+   err: text;
+   ok: DocumentVerification;
+ };
+type PriorityStatus = 
+ variant {
+   Active;
+   Expired;
+   ExpiringImminently;
+   Unknown;
+ };
+type OscarVerificationInput = 
+ record {
+   confidence: nat;
+   documentType: text;
+   extractedData: text;
+   issues: vec OscarIssue;
+   mismatches: vec DataMismatch;
+   requiresSolicitorReview: bool;
+ };
+type OscarVerificationDetails = 
+ record {
+   analysisTimestamp: Time;
+   confidence: nat;
+   documentType: text;
+   extractedData: text;
+   issues: vec OscarIssue;
+   mismatches: vec DataMismatch;
+   requiresSolicitorReview: bool;
+ };
+type OscarIssue = 
+ record {
+   code: text;
+   field: opt text;
+   message: text;
+   severity: variant {
+               error;
+               info;
+               warning;
+             };
+ };
+type OfficialCopyVerification = 
+ record {
+   copyType: LRDocumentType;
+   documentAge: nat;
+   hashVerified: bool;
+   isCurrent: bool;
+   issuedAt: int;
+   titleNumberMatches: bool;
+   verifiedAt: int;
+   verifiedBy: principal;
+ };
+type OSCertificateVerification = 
+ record {
+   advisoryEntries: vec text;
+   daysRemaining: opt int;
+   hashVerified: bool;
+   priorityExpiry: opt int;
+   priorityStatus: PriorityStatus;
+   registerChangedFlag: opt bool;
+   titleNumberMatches: bool;
+   verifiedAt: int;
+   verifiedBy: principal;
+ };
+type LRDocumentType = 
+ variant {
+   AP1Acknowledgement;
+   CompletionConfirmation;
+   LandChargesSearchK16;
+   LocalAuthoritySearch;
+   OfficialCopyRegister;
+   OfficialCopyTitlePlan;
+   OfficialSearchCertificate;
+   RegisterExtract;
+   RequisitionNotice;
+   SearchOfPartCertificate;
+ };
+type LRDocumentSummary = 
+ record {
+   documentType: LRDocumentType;
+   isCurrent: bool;
+   isVerified: bool;
+   landRegistryReference: opt text;
+   validUntil: opt int;
+ };
+type DocumentVerification = 
+ record {
+   calculatedHash: text;
+   documentId: nat;
+   documentType: text;
+   expectedHash: text;
+   expiresAt: opt Time;
+   failureReason: opt text;
+   hashVerified: bool;
+   id: nat;
+   isValid: bool;
+   notes: opt text;
+   propertyId: nat;
+   verificationDate: Time;
+   verificationMethod: VerificationMethod;
+   verifiedBy: principal;
+ };
+type DocumentMetadata = 
+ record {
+   contentType: opt text;
+   documentHash: text;
+   documentType: text;
+   fileName: opt text;
+   fileSize: opt nat;
+   id: nat;
+   isVerified: bool;
+   lastVerificationId: opt nat;
+   propertyId: nat;
+   storageDocumentId: opt nat;
+   transactionId: opt nat;
+   uploadedAt: Time;
+   uploadedBy: principal;
+ };
+type DataMismatch = 
+ record {
+   expected: text;
+   field: text;
+   found: text;
+ };
+type AuditLog = 
+ record {
+   action: text;
+   actorType: ActorType;
+   delegatedBy: opt principal;
+   details: text;
+   documentId: nat;
+   id: nat;
+   performedBy: principal;
+   success: bool;
+   timestamp: Time;
+ };
+type ActorType = 
+ variant {
+   agent;
+   systemActor;
+   user;
+ };
+service : {
+  deleteDocument: (documentId: nat) -> (variant {
+                                          err: text;
+                                          ok;
+                                        });
+  getAuditLogs: () -> (vec AuditLog) query;
+  getConfiguration: () ->
+   (record {
+      documentStorage: opt principal;
+      userManagement: opt principal;
+    }) query;
+  getCycles: () -> (nat) query;
+  getDocument: (id: nat) -> (opt DocumentMetadata) query;
+  getDocumentVerifications: (documentId: nat) ->
+   (vec DocumentVerification) query;
+  getOscarVerificationDetails: (verificationId: nat) ->
+   (opt OscarVerificationDetails) query;
+  getPropertyDocuments: (propertyId: nat) -> (vec DocumentMetadata) query;
+  getRecentAuditLogs: (limit: nat) -> (vec AuditLog) query;
+  getStats: () ->
+   (record {
+      totalAuditLogs: nat;
+      totalDocuments: nat;
+      totalVerifications: nat;
+      verifiedDocuments: nat;
+    }) query;
+  getTransactionVerificationSummary: (transactionId: text, titleNumber:
+   text) -> (Result_4);
+  getUnverifiedDocuments: (propertyId: nat) -> (vec DocumentMetadata) query;
+  getVerification: (verificationId: nat) -> (opt DocumentVerification) query;
+  getVerificationsByTransaction: (txId: nat) ->
+   (vec DocumentVerification) query;
+  getVerificationsByVerifier: (verifier: principal) ->
+   (vec DocumentVerification) query;
+  recordAuditEntry: (actorType: ActorType, delegatedBy: opt principal,
+   action: text, documentId: nat, details: text, success: bool) -> (Result_3);
+  registerDocument: (propertyId: nat, transactionId: opt nat, documentType:
+   text, documentHash: text, storageDocumentId: opt nat, fileName: opt text,
+   fileSize: opt nat, contentType: opt text) -> (nat);
+  setDocumentStorageCanister: (canisterId: principal) -> ();
+  setUserManagementCanister: (canisterId: principal) -> ();
+  verifyDocument: (documentId: nat) -> (bool);
+  verifyDocumentWithHash: (documentId: nat, notes: opt text) -> (Result);
+  verifyOfficialCopy: (documentId: nat, expectedTitleNumber: text,
+   maxAgeDays: nat) -> (Result_2);
+  verifyOfficialSearchCertificate: (documentId: nat, expectedTitleNumber:
+   text, _expectedTransactionId: opt text) -> (Result_1);
+  verifyWithCommercialAPI: (_documentId: nat, _apiProvider: text,
+   _verificationData: text) -> (Result);
+  verifyWithDVLA: (_documentId: nat, _drivingLicenseNumber: text) -> (Result);
+  verifyWithOscar: (documentId: nat, oscarResult: OscarVerificationInput) ->
+   (Result);
+  verifyWithPassportDCS: (_documentId: nat, _passportNumber: text) ->
+   (Result);
+}