openapi: 3.2.0 info: version: 2.3.0 title: Intelliworks Transaction Requests API description: "The purpose of the Intelliworks Create Case API is to enable Case creation from outside Intelliworks environment, and to unlock a more efficient process for users, by reducing manual data entry.\n\nAny action performed via the API will be visible in the Intelliworks UI, and the further action can be performed either in the UI or via the API. The intent is to ensure data accuracy between applications, avoiding the need to re-key information. This is primarily a technical pack intended for developers. It will provide an explanation of the service, the calls involved and some sample requests.\n\n# Overview\n\nThis current released version of the API pack enables:\n\n## Cases\n### Create new case\n\nYou can create new cases via the API for the following types;\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Workflow typeWorkflow ID
Sale220-Sale
Purchase210-Purchase
New build purchase216-New Build Purchase
General Property10200-General Property
Remortgage300-Remortgage
Equity release360-Equity Release (360)
Transfer of Equity700-Transfer of Equity
Wills415-Wills
Lasting Power of Attorney500-Lasting Power of Attorney
Probate601-Probate
\n\nIt provides the option to create a new case, via the API, instead of by manually initiating the case from the Intelliworks user interface. A case in Intelliworks consists of key details such as clients, a descriptive summary, and the type of case. For conveyancing cases, it also includes property, and price agreed. When you create a case, you need to include the appropriate WorkflowID for the type of case you want to create\n\nThe branch ID is a unique ID created by Ochresoft. Each branch ID relates to a branch or site (office) of the customer. When you create a case via API, you must specify which branch the case should be created in by including the branch ID. For example, if the customer has an Oxford office with branch ID \"926a95j1-c120-4cfd-80dd-9572c99345a6\", you will need to send that ID in the message. If you haven't already got the branch IDs for the customer, request them from Ochresoft.\n\nOnce the case is created, the workflow operates in the same way as if the case had been created manually, ensuring the conveyancer is guided through the process, but without the need to re-key details already held in another application.\n\n### Update case\n\nYou can update an existing Intelliworks case via the API using the same workflow-specific request body as create case. Supply the parent `transactionId` from the original create case response when updating case details.\n\n### Get case\n\nRetrieve read-only case summary details from Intelliworks by branch and either an Intelliworks case reference (`caseId`) and/or an external case reference (`externalCaseId`). At least one of `caseId` or `externalCaseId` must be supplied.\n\n### Get milestone\n\nReturns the actual completion date of a milestone for a case. Supply `branchId`, `milestoneId`, and at least one of `caseId` or `externalCaseId`. Optionally include `workflowId` when required for the target workflow. Valid `milestoneId` values are listed in [Supported milestone IDs by workflow](#supported-milestone-ids).\n\n\nSupported milestone IDs by workflow:\n\n
\nGen. Priv. Cli.\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
MilestoneMilestone ID
FileOpened499
ClientCareLetterSent500
SignedClientCareLetterReceived501
ClientsIDVerified502
FileReview1503
FileReview2504
FileReview3505
FileReview4506
FileReview5507
FileReview6508
FileReview7509
FileReview8510
FileReview9511
FileReview10512
DateClosed513
\n\n
\nGeneral Property\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
MilestoneMilestone ID
FileOpened237
ClientCareSent238
SignedCareRecd239
ClientsIDVerified240
2ndFileReview242
3rdFileReview243
4thFileReview244
5thFileReview245
LastestFileReview246
DateClosed247
\n\n
\nLPAs\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
MilestoneMilestone ID
FileOpened307
ClientCareLetterSent308
SignedCopyClientCareLetterReturned309
ClientIDVerified310
AppointmentConfirmationSent311
LPAQuestionnaireSent312
LPAQuestionnaireReturned313
InitialMeeting314
AttorneyBankruptcySearchesDone315
MedicalChecksComplete316
FeeEarnerRiskManagementReview317
CertificateProviderRequestSent318
CertificateProviderReplyReceived319
LPAFormsSentForSigning320
SignedLPAFormsReceived321
LPAsSigned322
NoticeSent323
LPASubmittedToOPG324
NotificationOfSubmissionSent325
LPAsRegistered326
LPACopiesIssued327
BillIssued328
FileClosed329
LPAExecutedDate330
\n\n
\nNew Build Purchase\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
MilestoneMilestone ID
QuoteProduced399
DateInstructed400
InitialCallToClientAttempted401
InitialCallToClientCompleted402
CareLetterSent403
WelcomePackSent404
VirtualFirmCredentials405
IntroductorySMS406
ClientIdVerified407
ClientInfoForm408
SignedCareLetterReceived409
AllInitialDocumentReceived410
SignedDeclarationReceived411
MemoOfSaleReceived412
ContractRequested413
ContractReceived414
PropInfoFormReceived415
LeaseholdInfoFormReceived416
FFFormReceived417
EPCReceived418
LocalSearchRequested419
LocalSearchReceived420
EnquiriesRaised421
EnquiriesReceived422
FurtherEnquiriesRaised423
FurtherEnquiriesReceived424
RepliesToSomeEnquiriesRecd425
RepliesToAllEnquiriesRecd426
ReportOnSearchesSentToClient427
SearchesSatisfactory428
LeaseholdInformationRequested429
LeaseholdInformationReceived430
TitleChecked431
ContractApproved432
ContractSentToClient433
SignedContractHeld434
ReportToClient435
MortgageOfferReceived436
OfferReportMortgageDeedSent437
SignedMortgageDeedReceived438
PropertyInsuranceConfirmed439
TransferApproved440
SignedTransferReceived441
AssessReadinessForExchange442
ReadyToExchange443
BillPrepared444
ClientCompletionStatement445
RequisitionsOnTitleSent446
RequisitionsOnTitleReceived447
SignedSDLTFormsHeld448
ActualExchange449
PrioritySearchesSubmitted450
CompletionDateNoticeReceived451
ContractualCompletion452
ActualCompletion453
SDLTSubmission455
SDLT5Received456
RegistrationApplicationSent457
CompletedRegistrationReceived458
SatisfactionQuestionnaireSent459
CaseClosed460
DateAbortInterim461
DateAborted462
HTBAuthorityToProceedReceived463
HTBAuthorityToProceedDate464
HTBSolicitorsForm1Prepared465
HTBSolicitorsForm1Sent466
HTBDisclosuresMadeToHelpToBuyAgent467
HTBAgrentHasAgreedToProceedafterDisclosures468
HTBNoticeGivenToQualifiyingLender469
HTBReportedOnHelpToBuySchemeToClient470
HTBSignedHTBFirstTimeBuyerDeclarationRecd471
HTBSolicitorsForm2Prepared472
HTBSolicitorsForm2Sent473
HTBAuthorityToExchangeReceived474
HTBNoticeOfHelpToBuyChargesServedOnLender475
HTBPostCompletionDocumentsSentToHomeAgent476
HTBHelpToBuyISABonusAppliedFor477
HTBHelpToBuyISABonusReceived478
MoneyOnAccountReceived520
\n\n
\nProbate\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
MilestoneMilestone ID
FileOpened248
ClientCareLetterSent249
SignedCopyClientCareLetterRecd250
SignedGeneralAuthorityRecd251
SignedAuthorityToObtainWillRecd252
PowerOfAttorneyCompleted253
ProbateQuestionnaireReceived254
ForeignDomicileQuestRecd255
DeathRegistered256
DeathCertificateReceived257
DeathCertVerificationFormPrepared258
DeceasedBankruptcySearchDone259
WillObtained260
AllPersonalRepresentativesIDVerified261
PRsBankruptcySearchesDone262
BeneficiaryIDChecksDone263
BeneficiariesEntitlementAdvised264
MinorsBirthCertsReceived265
StatutoryAdvertInLondonGazette266
StatutoryAdvertInLocalPaper267
NilRateBandDetailsReceived268
FuneralAccountPaid269
IHTReferenceAppliedFor270
IHTReferenceAppliedReceived271
IHTPaymentArranged272
IHTFormsSentToPRsForSignature273
OathAffidavitsIHTFormsSworn274
IHTFormsPrepared275
IHTFormsSubmitted276
NoticesServedOnNonProvingExecs277
GrantApplicationLodged278
GrantIssued279
CashRaisedForAdminPurposes280
EstateDebtsPaid281
DeedOfVariationPrepared282
IncomeTaxToDateOfDeathSettled283
InterimAccountsSentToPRs284
PRsApprovedInterimAccounts285
InterimEstateAccountsToResiduaryBens286
BeneficiaryBankruptcySearchesDone287
CorrectiveAccountLodged288
PecuniaryLegateesConfirmedLegacysRecd289
SpecificDevisesConfirmedLegacysRecd290
SpecificLegacysConfirmedLegacysRecd291
InterimDistributionToResiduaryBeneficiarys292
TaxPositionDuringAdminSettled293
IHTClearanceCertAppliedFor294
IHTClearanceCertificateRecd295
EstateAccountsPrepared296
FinalAccountsToPRsForApproval297
PRsApprovalOfAccountsRecd298
FinalEstateAccountsSentToResiduaryBeneficiarys299
FinalDistributionMadeToResiduaryBeneficiarys300
ResiduaryBeneficiarysConfirmedReceiptOfResidue301
EstateClosed302
FileClosed303
ReferrerAccountPaid304
AllRepliesReceivedToInitialLetters305
InitialLettersToOrganisationsSent306
InitialContactCallAttempted490
InitialContactCallMade491
IntroductorySMSsent492
VirtualFirmCredentialsSent493
AcknowledgeSignedToBreceived494
RenunciationRequested495
RenunciationAccepted496
InitialAdvice497
PRAdvisedGrantReceived498
\n\n
\nPurchase\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
MilestoneMilestone ID
QuoteProduced1
DateInstructed2
InitialCallToClientCompleted3
CareLetterSent4
VirtualFirmCredentials5
IntroductorySMS6
ClientIdVerified7
ClientInfoForm8
SignedCareLetterReceived9
MemoOfSaleReceived10
ContractRequested11
ContractReceived12
PropInfoFormReceived13
LeaseholdInfoFormReceived14
FFFormReceived15
EPCReceived16
LocalSearchRequested17
LocalSearchReceived18
EnquiriesRaised19
EnquiriesReceived20
FurtherEnquiriesRaised21
FurtherEnquiriesReceived22
LeaseholdInformationRequested23
LeaseholdInformationReceived24
TitleChecked25
ContractApproved26
ContractSentToClient27
SignedContractHeld28
ReportToClient29
MortgageOfferReceived30
TransferApproved31
AssessReadinessForExchange32
ReadyToExchange33
BillPrepared34
ClientCompletionStatement35
RequisitionsOnTitleSent36
RequisitionsOnTitleReceived37
ActualExchange39
ContractualCompletion40
LenderCompletionMoney41
ActualCompletion42
SDLTSubmission43
RegistrationApplicationSent45
CompletedRegistrationReceived46
SatisfactionQuestionnaireSent47
DateAborted49
InitialCallToClientAttempted357
WelcomePackSent358
AllInitialDocumentsReceived359
SignedDeclarationReceived360
RepliesToSomeEnquiries361
RepliesToAllEnquiries362
ReportOnSearchesToClient363
SearchesOk364
HelptoBuyClientReport365
MortgageOffertoClient366
SignedMortgageDeed367
PropertyInsuranceConfirmed368
SignedTransferReceived369
HelptoBuyISABonusAppliedFor370
HelptoBuyBonusReceived371
BankruptcySearchesSubmitted372
PrioritySearchesSubmitted373
DateAbortInterim374
MoneyOnAccountReceived519
\n\n
\nRemortgage\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
MilestoneMilestone ID
QuoteProduced151
DateInstructed152
InitialCallToClientCompleted153
CareLetterSent154
VirtualFirmCredentials155
IntroductorySMS156
SignedCareLetterReceived157
ClientInfoForm158
ClientIdVerified159
MoneyOnAccountIn160
IndexMapRequested161
IndexMapReceived162
DeedsRequested163
DeedsReceived164
OfficialCopiesRequested165
OfficialCopiesReceived166
RedStatsRequested167
RedStatsReceived168
MortgageOfferReceived169
MortgageDeedSent170
MortgageDeedHeld171
RevisedMortgageOfferReceived172
RevisedMortgageDeedSent173
RevisedMortgageDeedHeld174
LeaseholdInformationRequested175
LeaseholdInformationReceived176
LocalSearchRequested177
LocalSearchReceived178
CertifciateofTitle179
FeeEarnerRevew180
BillPrepared181
ClientCompletionStatement182
SignedTransfer183
TenancyAgreementReceived184
CompletionSetFor185
LenderCompletionMoney186
ActualCompletion187
RegistrationApplicationSent188
CompletedRegistrationReceived189
SatisfactionQuestionnaireSent190
DateAborted191
CaseClosed192
TitleChecked203
ReportToClient204
AllReceivedClient205
InitialCallToClientAttempted487
\n\n
\nSale\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
MilestoneMilestone ID
QuoteProduced100
DateInstructed101
InitialCallToClientCompleted102
CareLetterSent103
VirtualFirmCredentials104
IntroductorySMS105
IndexSearchRequested106
IndexSearchReceived107
ClientInfoForm108
ClientIdVerified109
MemoOfSaleReceived110
FFFormReceived111
PropInfoFormReceived112
PropQuestFormReceived113
LeaseholdInfoFormReceived114
OverridingQuestionnaireReceived115
SurplusFormReceived116
SignedCareLetterReceived117
MoneyOnAccountReceived118
DeedsRequested119
RedStatsRequested120
DeedsReceived121
SolsInitialLetter122
ContractIssued123
LeaseholdInformationRequested124
LeaseholdInformationReceived125
EnquiriesClientAnswered126
EnquiriesReply127
ContractApproved128
RequisitionsOnTitleReceived129
DraftTransferReceived130
RepliesToRequisitionsOnTitle131
FurtherEnquiriesReceived132
FurtherEnquiriesReply133
TransferApproved134
ContractSentToClient135
SignedContractHeld136
ReadyToExchange137
BillPrepared138
ClientCompletionStatement139
ActualExchange140
ContractualCompletion141
ActualCompletion142
SatisfactionQuestionnaireSent143
CaseClosed144
DateAborted145
EnquiriesReceived146
EnquiriesToClient147
RedStatsReceived148
FinalRedStatsReceived149
FinalRedStatsRequested150
TitleInformationRequested201
TitleInformationReceived202
InitialCallToClientAttempted479
WelcomePackSent480
FFFormSent481
AllRepliesToEnquiriesAnswered482
BuyersConveyancerSatisfiedWithReplies483
SignedTransferReceived484
BankruptcySearchSubmitted485
DateAbortedInterim486
\n\n
\nWills\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
MilestoneMilestone ID
FileOpened332
ClientCareLetterSent333
SignedCareLetterReceived334
ClientsIDVerified335
WillQuestionnairePrepared336
WillQuestionnaireReceived337
PreviousWillRequested338
PreviousWillReceived339
InitialMeetingAttendanceNotePrepared341
DraftWillPrepared342
DoctorsCapacityReportRequested343
DoctorsCapacityReportReceived344
SeveranceOfJointTenancyApplicationPrepared345
NoticeOfSeveranceOfJointTenancyPrepared346
FeeEarnerRiskManagementReview347
CaseLockedDownRiskConcerns348
CaseUnlocked349
WillSentForExecutionWithoutSupervision350
MeetingWithClientForWillExecution351
WillExecuted352
ExecutedWillReceivedForStorage353
DateClosed354
DraftWillApproved355
DraftWillSentForApproval356
\n\n### Asynchronous processing and status notifications\n\nSeveral endpoints, including create/update case, create/update task, create/update milestone, and upload document, are processed asynchronously. Each accepted request returns a `transactionRequestId` that you use to track progress.\n\nYou can receive status in either of the following ways:\n\n**1. Poll transaction status**\n\nCall `GET /transaction-requests/{transactionRequestId}`. See [Get transaction request status](#get-transaction-request-status) for supported `status` values.\n\n**2. Webhook callback (optional)**\n\nOptionally include a callback URL on the request. When processing completes, the Experience API sends an HTTP `POST` to that URL with the same status response.\n\nIf you use webhooks, tell Ochresoft in advance how your callback endpoint should be authenticated so we can configure it for your integration.\n\n### Create or update task\n\nCreate or update an **unscheduled** task on an existing Intelliworks case. Intelliworks is workflow-driven: scheduled workflow tasks cannot be created through this API. Only the unscheduled task combinations listed in [Supported unscheduled task mappings](#supported-unscheduled-task-mappings) are valid.\n\n* **Create** - omit `clientTaskId`; a new identifier is returned in the response.\n* **Update** - supply the `clientTaskId` returned from the original create response.\n* At least one of `caseId` or `externalCaseId` is required.\n* `completionDate` is mandatory when `status` is `Closed`.\n\nRequests that use a `processReference`, `taskReference`, and `taskType` combination outside the supported mapping may be rejected with an error, or the task may be created in Intelliworks but not function correctly in the workflow.\n\n\nSupported unscheduled task mappings:\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Task nameProcess reference (Pref)Task referenceTask type
ATTACHMAILUSPMAIL2Email
CDATAIMPORTUSPIMPORTCASEDATAImport
CLONEDCONTENT_EXTERNAL_ACCOUNTSTRANSACTION_ADDEDUSPSYST09Query
CLONEDCONTENT_FAXUSPSYST06Fax
CLONEDCONTENT_IMPORTUSPSYST04Import
CLONEDCONTENT_SCANNERUSPSYST05Scanner
CLONEDCONTENT_VF_MESSAGEUSPSYST08VirtualFirmMessage
FAXIMPORTUSPSYST07Fax
IMPORTFILEUSPIMPF1Import
IMPORTSCANUSPIMPORTSCANImport
MULTI_EMAIL_IMPORTUSPMAIL3Action
SCANNERIMPORTUSPSYST01Scanner
SENDMAILUSPMAIL1Email
\n\nMap `processReference` to **Pref**, `taskReference` to **Task reference**, and `taskType` to **Task type**. Use the **Task name** value as the task `description` unless your integration agreement specifies otherwise.\n\n### Create or update milestone\n\nSet or update milestone actual and/or forecast dates for a case. Supply `branchId`, at least one of `caseId` or `externalCaseId`, and one or more milestones. Valid `milestoneId` values are listed in [Supported milestone IDs by workflow](#supported-milestone-ids).\n\n### Upload document\n\nUpload a document against an Intelliworks case. A document can be uploaded as part of an `IMPORTFILE` task.\n\n### List case documents\n\nReturns the list of completed documents held against a case in Intelliworks for the specified branch. Supply at least one of `caseId` (Intelliworks case reference, e.g. `EXP-000762`) and/or `externalCaseId` (e.g. `AAR801/1`). Each document in the response can be downloaded using the Download document endpoint (`GET /documents/{id}/download`).\n\n### Download document\n\nDownloads a document by document ID (as returned in the List case documents response).\n\n\n### Get transaction request status\n\nReturns the latest processing status for any asynchronous Experience API request identified by `transactionRequestId`.\n\nSupported `status` values:\n\n* `Accepted`\n* `Queued`\n* `Processing`\n* `Completed`\n* `Failed`\n\nPoll `GET /transaction-requests/{transactionRequestId}` until `status` is `Completed` or `Failed`.\n\n\n# Endpoints\nThe API is accessed by making HTTPS requests to an endpoint URL.\nEvery endpoint is accessed only via the SSL-enabled HTTPS (port 443) protocol.\nThe API uses semantic versioning, and the current release is v1.0.0\n\n# Environments\nThe API is available in two environments, both are identical in that they have the same specification infrastructure and functionality.\n\nThe 2 environments are:\n* User Acceptance Testing (UAT)\n* Production (PRD)\n\n## UAT\nThe UAT environment should be used during development, and interfaces with the Intelliworks UAT environment.\nYou should use this whilst implementing and testing your integration.\n\nThe URLs for the UAT APIs are:\n* Base URL: https://uat-api.landmarkcloudservices.com/intelliworks/experience\n* Auth: https://lmkmaster.eu.auth0.com/oauth/token\n\n## PRD\nThe PRD environment is a live instance, and this talks to the live Intelliworks environment.\nThis should only be used once the integration is considered production ready and all testing has been completed on the UAT environment.\nAny actions performed on PRD will result in the creation and syncing of real data that may be seen by users.\n\nThe URLs for the production APIs are:\n* Base URL: https://api.landmarkcloudservices.com/intelliworks/experience\n* Auth: https://lmkmaster.eu.auth0.com/oauth/token\n\n# Requests & Authentication\nRequests must be sent over HTTPS with any payload formatted in JSON. To authenticate against the API a Bearer Token Header must be provided.\n\n# Rate limiting\nThe API allows a maximum of 250 requests per customer per minute.\n" contact: name: API Support email: support@ochresoft.com x-phone-number: +44 (0)3300 366 700 servers: - url: https://api.landmarkcloudservices.com/ description: Production API - url: https://uat-api.landmarkcloudservices.com/ description: UAT API security: - bearerAuth: [] tags: - name: Transaction Requests description: APIs for tracking asynchronous request status paths: /transaction-requests/{transactionRequestId}: get: summary: Get transaction request status description: 'Returns the latest processing status for an asynchronous Experience API request identified by `transactionRequestId`. Supports create/update case, upsert task, upsert milestone, document upload, and future asynchronous endpoints. Use this endpoint to poll for completion when a webhook callback is not used or not received. ' operationId: getTransactionRequestStatus tags: - Transaction Requests parameters: - name: transactionRequestId in: path required: true schema: $ref: '#/components/schemas/lgsUuid' description: Unique Experience API transaction request identifier returned by asynchronous endpoints responses: '200': description: Latest transaction request status found content: application/json: schema: $ref: '#/components/schemas/transactionRequestStatusResponse' '400': $ref: '#/components/responses/400BadRequest' '401': $ref: '#/components/responses/401Unauthorized' '403': $ref: '#/components/responses/403Forbidden' '404': $ref: '#/components/responses/404NotFound' '500': $ref: '#/components/responses/500InternalServerError' components: responses: 400BadRequest: description: Bad Request headers: traceresponse: $ref: '#/components/headers/lgsTraceResponse' content: application/problem+json: schema: $ref: '#/components/schemas/lgsErrorResponse' examples: Invalid content type supplied: value: status: '400' code: '40000' title: Invalid content type supplied Validation error: value: status: '400' code: '40001' title: Validation error Invalid traceparent http header: value: status: '400' code: '40002' title: Invalid trace header No matching data found: value: status: '400' code: '40003' title: No matching data found Invalid header: value: status: '400' code: '40004' title: Invalid header Third party error: value: status: '400' code: '40005' title: Third party error 500InternalServerError: description: Internal Server Error headers: traceresponse: $ref: '#/components/headers/lgsTraceResponse' content: application/problem+json: schema: $ref: '#/components/schemas/lgsErrorResponse' examples: Resource not found: value: status: '500' code: '50000' title: Internal server error messages: - message: Sorry, something has gone wrong whilst processing your request. An error has been logged and our support team will investigate this shortly. Please try again later and if the issue persists, please contact your Account Manager referencing the value 00-199c8ce55dc743a88661498aa8eb2cfc--00. 404NotFound: description: Not Found headers: traceresponse: $ref: '#/components/headers/lgsTraceResponse' content: application/problem+json: schema: $ref: '#/components/schemas/lgsErrorResponse' examples: Entity not found: value: status: '404' code: '40401' title: Entity not found 401Unauthorized: description: Unauthorized headers: traceresponse: $ref: '#/components/headers/lgsTraceResponse' content: application/problem+json: schema: $ref: '#/components/schemas/lgsErrorResponse' examples: Invalid identity: value: status: '401' code: '40100' title: Invalid identity 403Forbidden: description: Forbidden headers: traceresponse: $ref: '#/components/headers/lgsTraceResponse' content: application/problem+json: schema: $ref: '#/components/schemas/lgsErrorResponse' examples: Invalid Entitlement: value: status: '403' code: '40300' title: Invalid Entitlement No Entitlement: value: status: '403' code: '40301' title: No Entitlement No permission to entity: value: status: '403' code: '40302' title: No permission to entity User not registered: value: status: '403' code: '40303' title: User not registered Usage limit reached: value: status: '403' code: '40304' title: Usage limit reached Email account not verified: value: status: '403' code: '40305' title: Email account not verified Token expiry too long: value: status: '403' code: '40306' title: Token expiry too long schemas: transactionRequestStatusResponse: type: object additionalProperties: false description: Latest status of an asynchronous Experience API transaction request required: - transactionRequestId - entityType - operationType - status - updatedDateUtc properties: transactionRequestId: $ref: '#/components/schemas/lgsUuid' transactionId: $ref: '#/components/schemas/lgsUuid' entityType: type: string enum: - Case - Milestone - Task - Document operationType: type: string enum: - Create - Update - Upload status: type: string enum: - Accepted - Queued - Processing - Completed - Failed description: Latest processing status for the transaction request. caseId: type: - string - 'null' maxLength: 25 pattern: ^[a-zA-Z0-9@ :#$%^&+=*()_+-/]*$ externalCaseId: type: - string - 'null' maxLength: 50 pattern: ^[a-zA-Z0-9@ :#$%^&+=*()_+-]*$ taskId: $ref: '#/components/schemas/lgsUuid' documentId: $ref: '#/components/schemas/lgsUuid' message: type: - string - 'null' errorMessage: type: - string - 'null' updatedDateUtc: type: string format: date-time description: UTC timestamp of the latest audit record for this transaction request lgsUuid: type: string format: uuid minLength: 36 maxLength: 36 pattern: ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$ lgsErrorResponse: type: object additionalProperties: false required: - status - code - title properties: status: type: string minLength: 3 maxLength: 3 pattern: ^[0-9]{3}$ code: type: string minLength: 5 maxLength: 5 pattern: ^[0-9]{5}$ title: type: string minLength: 1 maxLength: 100 messages: type: array maxItems: 100 items: type: object additionalProperties: false required: - message properties: property: type: string minLength: 1 maxLength: 1000 message: type: string minLength: 1 maxLength: 1000 headers: lgsTraceResponse: description: Trace context providing an unique identifier for an individual requests schema: type: string minLength: 39 maxLength: 39 pattern: ^[0-9a-fA-F]{2}-[0-9a-fA-F]{32}--[0-9a-fA-F]{2}$ examples: Example traceresponse: value: 00-199c8ce55dc743a88661498aa8eb2cfc--00 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT x-tagGroups: - name: General tags: - Cases - Documents - Transaction Requests