API docs by Redocly

Intelliworks APIs (2.3.0)

Download OpenAPI specification:

API Support: support@ochresoft.com

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.

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

Overview

This current released version of the API pack enables:

Cases

Create new case

You can create new cases via the API for the following types;

Workflow type Workflow ID
Sale 220-Sale
Purchase 210-Purchase
New build purchase 216-New Build Purchase
General Property 10200-General Property
Remortgage 300-Remortgage
Equity release 360-Equity Release (360)
Transfer of Equity 700-Transfer of Equity
Wills 415-Wills
Lasting Power of Attorney 500-Lasting Power of Attorney
Probate 601-Probate

It 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

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

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

Update case

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

Get case

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

Get milestone

Returns 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 by workflow:

Gen. Priv. Cli.
MilestoneMilestone ID
FileOpened 499
ClientCareLetterSent 500
SignedClientCareLetterReceived 501
ClientsIDVerified 502
FileReview1 503
FileReview2 504
FileReview3 505
FileReview4 506
FileReview5 507
FileReview6 508
FileReview7 509
FileReview8 510
FileReview9 511
FileReview10 512
DateClosed 513
General Property
MilestoneMilestone ID
FileOpened 237
ClientCareSent 238
SignedCareRecd 239
ClientsIDVerified 240
2ndFileReview 242
3rdFileReview 243
4thFileReview 244
5thFileReview 245
LastestFileReview 246
DateClosed 247
LPAs
MilestoneMilestone ID
FileOpened 307
ClientCareLetterSent 308
SignedCopyClientCareLetterReturned 309
ClientIDVerified 310
AppointmentConfirmationSent 311
LPAQuestionnaireSent 312
LPAQuestionnaireReturned 313
InitialMeeting 314
AttorneyBankruptcySearchesDone 315
MedicalChecksComplete 316
FeeEarnerRiskManagementReview 317
CertificateProviderRequestSent 318
CertificateProviderReplyReceived 319
LPAFormsSentForSigning 320
SignedLPAFormsReceived 321
LPAsSigned 322
NoticeSent 323
LPASubmittedToOPG 324
NotificationOfSubmissionSent 325
LPAsRegistered 326
LPACopiesIssued 327
BillIssued 328
FileClosed 329
LPAExecutedDate 330
New Build Purchase
MilestoneMilestone ID
QuoteProduced 399
DateInstructed 400
InitialCallToClientAttempted 401
InitialCallToClientCompleted 402
CareLetterSent 403
WelcomePackSent 404
VirtualFirmCredentials 405
IntroductorySMS 406
ClientIdVerified 407
ClientInfoForm 408
SignedCareLetterReceived 409
AllInitialDocumentReceived 410
SignedDeclarationReceived 411
MemoOfSaleReceived 412
ContractRequested 413
ContractReceived 414
PropInfoFormReceived 415
LeaseholdInfoFormReceived 416
FFFormReceived 417
EPCReceived 418
LocalSearchRequested 419
LocalSearchReceived 420
EnquiriesRaised 421
EnquiriesReceived 422
FurtherEnquiriesRaised 423
FurtherEnquiriesReceived 424
RepliesToSomeEnquiriesRecd 425
RepliesToAllEnquiriesRecd 426
ReportOnSearchesSentToClient 427
SearchesSatisfactory 428
LeaseholdInformationRequested 429
LeaseholdInformationReceived 430
TitleChecked 431
ContractApproved 432
ContractSentToClient 433
SignedContractHeld 434
ReportToClient 435
MortgageOfferReceived 436
OfferReportMortgageDeedSent 437
SignedMortgageDeedReceived 438
PropertyInsuranceConfirmed 439
TransferApproved 440
SignedTransferReceived 441
AssessReadinessForExchange 442
ReadyToExchange 443
BillPrepared 444
ClientCompletionStatement 445
RequisitionsOnTitleSent 446
RequisitionsOnTitleReceived 447
SignedSDLTFormsHeld 448
ActualExchange 449
PrioritySearchesSubmitted 450
CompletionDateNoticeReceived 451
ContractualCompletion 452
ActualCompletion 453
SDLTSubmission 455
SDLT5Received 456
RegistrationApplicationSent 457
CompletedRegistrationReceived 458
SatisfactionQuestionnaireSent 459
CaseClosed 460
DateAbortInterim 461
DateAborted 462
HTBAuthorityToProceedReceived 463
HTBAuthorityToProceedDate 464
HTBSolicitorsForm1Prepared 465
HTBSolicitorsForm1Sent 466
HTBDisclosuresMadeToHelpToBuyAgent 467
HTBAgrentHasAgreedToProceedafterDisclosures 468
HTBNoticeGivenToQualifiyingLender 469
HTBReportedOnHelpToBuySchemeToClient 470
HTBSignedHTBFirstTimeBuyerDeclarationRecd 471
HTBSolicitorsForm2Prepared 472
HTBSolicitorsForm2Sent 473
HTBAuthorityToExchangeReceived 474
HTBNoticeOfHelpToBuyChargesServedOnLender 475
HTBPostCompletionDocumentsSentToHomeAgent 476
HTBHelpToBuyISABonusAppliedFor 477
HTBHelpToBuyISABonusReceived 478
MoneyOnAccountReceived 520
Probate
MilestoneMilestone ID
FileOpened 248
ClientCareLetterSent 249
SignedCopyClientCareLetterRecd 250
SignedGeneralAuthorityRecd 251
SignedAuthorityToObtainWillRecd 252
PowerOfAttorneyCompleted 253
ProbateQuestionnaireReceived 254
ForeignDomicileQuestRecd 255
DeathRegistered 256
DeathCertificateReceived 257
DeathCertVerificationFormPrepared 258
DeceasedBankruptcySearchDone 259
WillObtained 260
AllPersonalRepresentativesIDVerified 261
PRsBankruptcySearchesDone 262
BeneficiaryIDChecksDone 263
BeneficiariesEntitlementAdvised 264
MinorsBirthCertsReceived 265
StatutoryAdvertInLondonGazette 266
StatutoryAdvertInLocalPaper 267
NilRateBandDetailsReceived 268
FuneralAccountPaid 269
IHTReferenceAppliedFor 270
IHTReferenceAppliedReceived 271
IHTPaymentArranged 272
IHTFormsSentToPRsForSignature 273
OathAffidavitsIHTFormsSworn 274
IHTFormsPrepared 275
IHTFormsSubmitted 276
NoticesServedOnNonProvingExecs 277
GrantApplicationLodged 278
GrantIssued 279
CashRaisedForAdminPurposes 280
EstateDebtsPaid 281
DeedOfVariationPrepared 282
IncomeTaxToDateOfDeathSettled 283
InterimAccountsSentToPRs 284
PRsApprovedInterimAccounts 285
InterimEstateAccountsToResiduaryBens 286
BeneficiaryBankruptcySearchesDone 287
CorrectiveAccountLodged 288
PecuniaryLegateesConfirmedLegacysRecd 289
SpecificDevisesConfirmedLegacysRecd 290
SpecificLegacysConfirmedLegacysRecd 291
InterimDistributionToResiduaryBeneficiarys 292
TaxPositionDuringAdminSettled 293
IHTClearanceCertAppliedFor 294
IHTClearanceCertificateRecd 295
EstateAccountsPrepared 296
FinalAccountsToPRsForApproval 297
PRsApprovalOfAccountsRecd 298
FinalEstateAccountsSentToResiduaryBeneficiarys 299
FinalDistributionMadeToResiduaryBeneficiarys 300
ResiduaryBeneficiarysConfirmedReceiptOfResidue 301
EstateClosed 302
FileClosed 303
ReferrerAccountPaid 304
AllRepliesReceivedToInitialLetters 305
InitialLettersToOrganisationsSent 306
InitialContactCallAttempted 490
InitialContactCallMade 491
IntroductorySMSsent 492
VirtualFirmCredentialsSent 493
AcknowledgeSignedToBreceived 494
RenunciationRequested 495
RenunciationAccepted 496
InitialAdvice 497
PRAdvisedGrantReceived 498
Purchase
MilestoneMilestone ID
QuoteProduced 1
DateInstructed 2
InitialCallToClientCompleted 3
CareLetterSent 4
VirtualFirmCredentials 5
IntroductorySMS 6
ClientIdVerified 7
ClientInfoForm 8
SignedCareLetterReceived 9
MemoOfSaleReceived 10
ContractRequested 11
ContractReceived 12
PropInfoFormReceived 13
LeaseholdInfoFormReceived 14
FFFormReceived 15
EPCReceived 16
LocalSearchRequested 17
LocalSearchReceived 18
EnquiriesRaised 19
EnquiriesReceived 20
FurtherEnquiriesRaised 21
FurtherEnquiriesReceived 22
LeaseholdInformationRequested 23
LeaseholdInformationReceived 24
TitleChecked 25
ContractApproved 26
ContractSentToClient 27
SignedContractHeld 28
ReportToClient 29
MortgageOfferReceived 30
TransferApproved 31
AssessReadinessForExchange 32
ReadyToExchange 33
BillPrepared 34
ClientCompletionStatement 35
RequisitionsOnTitleSent 36
RequisitionsOnTitleReceived 37
ActualExchange 39
ContractualCompletion 40
LenderCompletionMoney 41
ActualCompletion 42
SDLTSubmission 43
RegistrationApplicationSent 45
CompletedRegistrationReceived 46
SatisfactionQuestionnaireSent 47
DateAborted 49
InitialCallToClientAttempted 357
WelcomePackSent 358
AllInitialDocumentsReceived 359
SignedDeclarationReceived 360
RepliesToSomeEnquiries 361
RepliesToAllEnquiries 362
ReportOnSearchesToClient 363
SearchesOk 364
HelptoBuyClientReport 365
MortgageOffertoClient 366
SignedMortgageDeed 367
PropertyInsuranceConfirmed 368
SignedTransferReceived 369
HelptoBuyISABonusAppliedFor 370
HelptoBuyBonusReceived 371
BankruptcySearchesSubmitted 372
PrioritySearchesSubmitted 373
DateAbortInterim 374
MoneyOnAccountReceived 519
Remortgage
MilestoneMilestone ID
QuoteProduced 151
DateInstructed 152
InitialCallToClientCompleted 153
CareLetterSent 154
VirtualFirmCredentials 155
IntroductorySMS 156
SignedCareLetterReceived 157
ClientInfoForm 158
ClientIdVerified 159
MoneyOnAccountIn 160
IndexMapRequested 161
IndexMapReceived 162
DeedsRequested 163
DeedsReceived 164
OfficialCopiesRequested 165
OfficialCopiesReceived 166
RedStatsRequested 167
RedStatsReceived 168
MortgageOfferReceived 169
MortgageDeedSent 170
MortgageDeedHeld 171
RevisedMortgageOfferReceived 172
RevisedMortgageDeedSent 173
RevisedMortgageDeedHeld 174
LeaseholdInformationRequested 175
LeaseholdInformationReceived 176
LocalSearchRequested 177
LocalSearchReceived 178
CertifciateofTitle 179
FeeEarnerRevew 180
BillPrepared 181
ClientCompletionStatement 182
SignedTransfer 183
TenancyAgreementReceived 184
CompletionSetFor 185
LenderCompletionMoney 186
ActualCompletion 187
RegistrationApplicationSent 188
CompletedRegistrationReceived 189
SatisfactionQuestionnaireSent 190
DateAborted 191
CaseClosed 192
TitleChecked 203
ReportToClient 204
AllReceivedClient 205
InitialCallToClientAttempted 487
Sale
MilestoneMilestone ID
QuoteProduced 100
DateInstructed 101
InitialCallToClientCompleted 102
CareLetterSent 103
VirtualFirmCredentials 104
IntroductorySMS 105
IndexSearchRequested 106
IndexSearchReceived 107
ClientInfoForm 108
ClientIdVerified 109
MemoOfSaleReceived 110
FFFormReceived 111
PropInfoFormReceived 112
PropQuestFormReceived 113
LeaseholdInfoFormReceived 114
OverridingQuestionnaireReceived 115
SurplusFormReceived 116
SignedCareLetterReceived 117
MoneyOnAccountReceived 118
DeedsRequested 119
RedStatsRequested 120
DeedsReceived 121
SolsInitialLetter 122
ContractIssued 123
LeaseholdInformationRequested 124
LeaseholdInformationReceived 125
EnquiriesClientAnswered 126
EnquiriesReply 127
ContractApproved 128
RequisitionsOnTitleReceived 129
DraftTransferReceived 130
RepliesToRequisitionsOnTitle 131
FurtherEnquiriesReceived 132
FurtherEnquiriesReply 133
TransferApproved 134
ContractSentToClient 135
SignedContractHeld 136
ReadyToExchange 137
BillPrepared 138
ClientCompletionStatement 139
ActualExchange 140
ContractualCompletion 141
ActualCompletion 142
SatisfactionQuestionnaireSent 143
CaseClosed 144
DateAborted 145
EnquiriesReceived 146
EnquiriesToClient 147
RedStatsReceived 148
FinalRedStatsReceived 149
FinalRedStatsRequested 150
TitleInformationRequested 201
TitleInformationReceived 202
InitialCallToClientAttempted 479
WelcomePackSent 480
FFFormSent 481
AllRepliesToEnquiriesAnswered 482
BuyersConveyancerSatisfiedWithReplies 483
SignedTransferReceived 484
BankruptcySearchSubmitted 485
DateAbortedInterim 486
Wills
MilestoneMilestone ID
FileOpened 332
ClientCareLetterSent 333
SignedCareLetterReceived 334
ClientsIDVerified 335
WillQuestionnairePrepared 336
WillQuestionnaireReceived 337
PreviousWillRequested 338
PreviousWillReceived 339
InitialMeetingAttendanceNotePrepared 341
DraftWillPrepared 342
DoctorsCapacityReportRequested 343
DoctorsCapacityReportReceived 344
SeveranceOfJointTenancyApplicationPrepared 345
NoticeOfSeveranceOfJointTenancyPrepared 346
FeeEarnerRiskManagementReview 347
CaseLockedDownRiskConcerns 348
CaseUnlocked 349
WillSentForExecutionWithoutSupervision 350
MeetingWithClientForWillExecution 351
WillExecuted 352
ExecutedWillReceivedForStorage 353
DateClosed 354
DraftWillApproved 355
DraftWillSentForApproval 356

Asynchronous processing and status notifications

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

You can receive status in either of the following ways:

1. Poll transaction status

Call GET /transaction-requests/{transactionRequestId}. See Get transaction request status for supported status values.

2. Webhook callback (optional)

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

If you use webhooks, tell Ochresoft in advance how your callback endpoint should be authenticated so we can configure it for your integration.

Create or update task

Create 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 are valid.

  • Create - omit clientTaskId; a new identifier is returned in the response.
  • Update - supply the clientTaskId returned from the original create response.
  • At least one of caseId or externalCaseId is required.
  • completionDate is mandatory when status is Closed.

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

Supported unscheduled task mappings:

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

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

Create or update milestone

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

Upload document

Upload a document against an Intelliworks case. A document can be uploaded as part of an IMPORTFILE task.

List case documents

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

Download document

Downloads a document by document ID (as returned in the List case documents response).

Get transaction request status

Returns the latest processing status for any asynchronous Experience API request identified by transactionRequestId.

Supported status values:

  • Accepted
  • Queued
  • Processing
  • Completed
  • Failed

Poll GET /transaction-requests/{transactionRequestId} until status is Completed or Failed.

Endpoints

The API is accessed by making HTTPS requests to an endpoint URL. Every endpoint is accessed only via the SSL-enabled HTTPS (port 443) protocol. The API uses semantic versioning, and the current release is v1.0.0

Environments

The API is available in two environments, both are identical in that they have the same specification infrastructure and functionality.

The 2 environments are:

  • User Acceptance Testing (UAT)
  • Production (PRD)

UAT

The UAT environment should be used during development, and interfaces with the Intelliworks UAT environment. You should use this whilst implementing and testing your integration.

The URLs for the UAT APIs are:

PRD

The PRD environment is a live instance, and this talks to the live Intelliworks environment. This should only be used once the integration is considered production ready and all testing has been completed on the UAT environment. Any actions performed on PRD will result in the creation and syncing of real data that may be seen by users.

The URLs for the production APIs are:

Requests & Authentication

Requests must be sent over HTTPS with any payload formatted in JSON. To authenticate against the API a Bearer Token Header must be provided.

Rate limiting

The API allows a maximum of 250 requests per customer per minute.

Cases

APIs related to your Cases

Create case

Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body containing workflow case data

workflowId
required
string (A workflowid for workflow)

A workflowid is associated with a case which belongs to specific workflow

branchId
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...
caseSummary
required
string (case summary for a workflow case) <= 60 characters ^.*$
Default: ""

A casesummary is what we are creating for a case

externalCaseId
required
string (externalCaseId) <= 50 characters ^.*$
Default: ""

The case reference from the external system

casePriorty
string (The casepriorty)
Default: "3"
Enum: "3" "2" "1"
required
Array of objects (clientsIw) [ 1 .. 4 ] items
dateInstructed
required
string <datetime> (The dateInstructed)

Date / time case created

transactionId
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...
required
object

These options are workflow specific

address (object)

Address of property for the new case eg lgsAddressAddressBaseCore

Responses

Request samples

Content type
application/json
Example
{
  • "workflowId": "210",
  • "branchId": "712f308d-801e-48bc-b072-9c404734ceb7",
  • "caseSummary": "",
  • "externalCaseId": "",
  • "casePriorty": "3",
  • "clients": [
    ],
  • "dateInstructed": "string",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "workflowOptions": { },
  • "transactionRequestSubject": {
    }
}

Response samples

Content type
application/json
{
  • "case": {
    }
}

Update case

Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body containing workflow case data

workflowId
required
string (A workflowid for workflow)

A workflowid is associated with a case which belongs to specific workflow

branchId
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...
caseSummary
required
string (case summary for a workflow case) <= 60 characters ^.*$
Default: ""

A casesummary is what we are creating for a case

externalCaseId
required
string (externalCaseId) <= 50 characters ^.*$
Default: ""

The case reference from the external system

casePriorty
string (The casepriorty)
Default: "3"
Enum: "3" "2" "1"
required
Array of objects (clientsIw) [ 1 .. 4 ] items
dateInstructed
required
string <datetime> (The dateInstructed)

Date / time case created

transactionId
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...
required
object

These options are workflow specific

address (object)

Address of property for the new case eg lgsAddressAddressBaseCore

Responses

Request samples

Content type
application/json
Example
{
  • "workflowId": "210",
  • "branchId": "712f308d-801e-48bc-b072-9c404734ceb7",
  • "caseSummary": "",
  • "externalCaseId": "",
  • "casePriorty": "3",
  • "clients": [
    ],
  • "dateInstructed": "string",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "workflowOptions": { },
  • "transactionRequestSubject": {
    }
}

Response samples

Content type
application/json
{
  • "case": {
    }
}

Get case summary

Returns a read-only case summary for the specified branch. Supply at least one of caseId (Intelliworks case reference, e.g. GPR-000856) and/or externalCaseId (reference from the external system). Both are forwarded to Intelliworks when provided.

Authorizations:
bearerAuth
query Parameters
branchId
required
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Branch identifier (UUID) used to resolve Intelliworks company and site identifiers.

caseId
string <= 50 characters ^[a-zA-Z0-9@ :#$%^&+=*()_+-]*$

Intelliworks case reference (forwarded as caseReference to Intelliworks).

externalCaseId
string <= 50 characters ^[a-zA-Z0-9@ :#$%^&+=*()_+-]*$

External case reference (forwarded as externalCaseReference to Intelliworks).

Responses

Response samples

Content type
application/json
{
  • "caseReference": "string",
  • "externalCaseReference": "string",
  • "workflowId": 99999,
  • "workflowDisplayName": "string",
  • "caseType": "string",
  • "caseDescription": "string",
  • "caseStatus": "string",
  • "caseProgress": "string",
  • "purchaseDate": "string",
  • "feeEarnerDetails": {
    },
  • "clients": [
    ],
  • "workReferrer": {
    },
  • "buyersConveyancer": {
    },
  • "sellersConveyancer": {
    },
  • "estateAgent": {
    },
  • "lenders": [
    ],
  • "lenderAccountNumbers": [
    ],
  • "lenderNotes": "string",
  • "propertyAddress": {
    },
  • "sellers": [
    ],
  • "price": {
    }
}

Create or update task

Create or update an unscheduled task on an existing case. At least one of caseId or externalCaseId must be supplied. Only supported combinations of processReference, taskReference, and taskType may be used - see Supported unscheduled task mappings.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body containing task data to create or update

One of
Any of
transactionRequestId
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...
transactionId
string or null^$|^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa...

Parent case transaction identifier from create case. Optional.

branchId
required
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...
clientTaskId
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...
callerId
string^[a-zA-Z0-9@ :#$%^&+=*()_+-]*$

Landmark caller identifier. Defaults from x-landmark-caller-id header when omitted.

clientCallbackUrl
string or null <url>

Optional callback URL.

workflowId
integer
Enum: 10200 10400 210 216 220 300 350 360 700 415 500 601

Workflow identifier. Optional when resolved from the case.

caseId
required
string or null <= 50 characters ^[a-zA-Z0-9@ :#$%^&+=*()_+-/]*$

Intelliworks case reference. At least one of caseId or externalCaseId is required.

externalCaseId
string or null <= 50 characters ^[a-zA-Z0-9@ :#$%^&+=*()_+-]*$

External case reference. At least one of caseId or externalCaseId is required.

processReference
required
string <= 15 characters ^[a-zA-Z0-9@ :#$%^&+=*()_+-]*$

Process reference (Pref). Must match a supported unscheduled task mapping.

taskReference
required
string <= 15 characters ^[a-zA-Z0-9@ :#$%^&+=*()_+-]*$

Task reference. Must match a supported unscheduled task mapping.

description
required
string <= 300 characters ^[a-zA-Z0-9@ :#$%^&+=*()_+-/.,' ]*$

Task description. Use the Task name from the supported mapping table.

taskType
required
string
Enum: "Email" "Import" "Document" "Query" "Fax" "Laserform" "Scanner" "VirtualFirmMessage" "Action"

Task type. Must match a supported unscheduled task mapping.

priority
integer
Default: 3

Task priority

status
string
Default: "Open"
Enum: "Open" "Complete" "InProgress" "Closed" "Cancelled"

Task status. completionDate is mandatory when status is Closed.

Value: "Closed"
targetDate
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Target completion date

completionDate
required
string <date-time> ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

Actual completion date. Mandatory when status is Closed.

estimatedDuration
string^\d{2}:\d{2}:\d{2}$

Estimated duration in HH:mm:ss format

category
string <= 50 characters ^[a-zA-Z0-9@ :#$%^&+=*()_+-]*$

Task category

subType
string <= 10 characters ^[a-zA-Z0-9@ :#$%^&+=*()_+-]*$

Task sub-type

resource
required
string <= 100 characters ^[a-zA-Z0-9@ :#$%^&+=*()_+-]*$

Resource assigned to the task

Responses

Request samples

Content type
application/json
Example
{
  • "transactionRequestId": "2c639a22-bc15-4f63-afbb-9a7b148b1146",
  • "transactionId": "string",
  • "branchId": "712f308d-801e-48bc-b072-9c404734ceb7",
  • "clientTaskId": "f8918f0e-1de1-4986-a4ea-ff9393df8011",
  • "callerId": "string",
  • "clientCallbackUrl": "string",
  • "workflowId": 10200,
  • "caseId": "string",
  • "externalCaseId": "string",
  • "processReference": "string",
  • "taskReference": "string",
  • "description": "string",
  • "taskType": "Email",
  • "priority": 3,
  • "status": "Closed",
  • "targetDate": "2019-08-24T14:15:22Z",
  • "completionDate": "2019-08-24T14:15:22Z",
  • "estimatedDuration": "string",
  • "category": "string",
  • "subType": "string",
  • "resource": "string"
}

Response samples

Content type
application/json
{
  • "task": {
    }
}

Get milestone

Returns the actual completion date of a milestone for a case. Supply at least one of caseId or externalCaseId. Valid milestoneId values are listed in Supported milestone IDs by workflow.

Authorizations:
bearerAuth
query Parameters
branchId
required
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...
caseId
string <= 25 characters ^[a-zA-Z0-9@ :#$%^&+=*()_+-/]*$
externalCaseId
string <= 50 characters ^[a-zA-Z0-9@ :#$%^&+=*()_+-]*$
milestoneId
required
integer <int32> >= 1

Milestone identifier. See Supported milestone IDs by workflow for valid values per workflow.

workflowId
integer <int32> >= 1

Optional workflow identifier. Include when required to resolve the milestone for the target workflow.

Responses

Response samples

Content type
application/json
{
  • "caseId": "string",
  • "externalCaseId": "",
  • "milestoneId": 1,
  • "actualDate": "2019-08-24T14:15:22Z"
}

Create or update milestone dates

Set or update milestone actual and/or forecast dates for a case. The request is accepted for asynchronous processing.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Request body containing milestone upsert data

transactionId
string or null^$|^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa...

Parent case transaction identifier from create case. Optional.

transactionRequestId
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...
branchId
required
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...
caseId
string <= 25 characters ^[a-zA-Z0-9@ :#$%^&+=*()_+-/]*$

Intelliworks case identifier

externalCaseId
string <= 50 characters ^[a-zA-Z0-9@ :#$%^&+=*()_+-]*$

External system case reference

workflowId
integer <int32> >= 1

Optional Intelliworks workflow identifier. When omitted, workflow context is resolved from the case.

callbackUrl
string or null <url>

Optional callback URL.

required
Array of objects (milestoneUpsertItem) non-empty

Responses

Request samples

Content type
application/json
{
  • "transactionId": "string",
  • "transactionRequestId": "2c639a22-bc15-4f63-afbb-9a7b148b1146",
  • "branchId": "712f308d-801e-48bc-b072-9c404734ceb7",
  • "caseId": "string",
  • "externalCaseId": "string",
  • "workflowId": 1,
  • "callbackUrl": "string",
  • "milestones": [
    ]
}

Response samples

Content type
application/json
{
  • "transactionRequestId": "2c639a22-bc15-4f63-afbb-9a7b148b1146",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "status": "Accepted"
}

Upload Document

Uploads a document for the specified case against a task or default. At least one of caseId or externalCaseId is required. taskId is optional; when omitted the document is stored against a new default task rather than an existing task. Upload the file directly using multipart/form-data, or optionally use application/json with document metadata.

Authorizations:
bearerAuth
Request Body schema:
required
Any of
transactionId
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...
branchId
required
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...
workflowId
integer <int32> >= 1

Optional workflow identifier.

caseId
required
string <= 50 characters ^[a-zA-Z0-9@ :#$%^&+=*()_+-/]*$

Intelliworks case reference (e.g. EXP-000762).

externalCaseId
string <= 50 characters ^[a-zA-Z0-9@ :#$%^&+=*()_+-]*$

External case reference (e.g. AAR801/1).

taskId
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...
required
object (uploadDocumentJsonDocument)

Document metadata and content for JSON upload requests

Responses

Request samples

Content type
{
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "branchId": "712f308d-801e-48bc-b072-9c404734ceb7",
  • "workflowId": 1,
  • "caseId": "string",
  • "externalCaseId": "string",
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "document": {
    }
}

Response samples

Content type
application/json
{
  • "transactionRequestId": "2c639a22-bc15-4f63-afbb-9a7b148b1146",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052"
}

Documents

APIs related to case documents

List case documents

Returns 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). Both are forwarded to Intelliworks when provided. Each document in the response can be downloaded using GET /documents/{id}/download.

Authorizations:
bearerAuth
query Parameters
branchId
required
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Branch identifier (UUID) used to resolve Intelliworks company and site identifiers.

caseId
string <= 50 characters ^[a-zA-Z0-9@ :#$%^&+=*()_+-]*$

Intelliworks case reference (e.g. EXP-000762).

externalCaseId
string <= 50 characters ^[a-zA-Z0-9@ :#$%^&+=*()_+-]*$

External case reference (e.g. AAR801/1).

workflowId
integer <int32> >= 1

Intelliworks workflow identifier.

Responses

Response samples

Content type
application/json
{
  • "caseId": "string",
  • "externalCaseId": "string",
  • "workflowId": 99999,
  • "documents": [
    ]
}

Download document

Downloads a document by document ID (as returned in the List case documents response). Auth0Id is extracted from the authenticated user context and forwarded to Intelliworks Web API.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Document ID.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Transaction Requests

APIs for tracking asynchronous request status

Get transaction request status

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.

Authorizations:
bearerAuth
path Parameters
transactionRequestId
required
string <uuid> (lgsUuid) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Unique Experience API transaction request identifier returned by asynchronous endpoints

Responses

Response samples

Content type
application/json
{
  • "transactionRequestId": "2c639a22-bc15-4f63-afbb-9a7b148b1146",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "entityType": "Case",
  • "operationType": "Create",
  • "status": "Accepted",
  • "caseId": "string",
  • "externalCaseId": "string",
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
  • "message": "string",
  • "errorMessage": "string",
  • "updatedDateUtc": "2019-08-24T14:15:22Z"
}