New HouseMove

The newHouseMove API call is only available to companies with a SlothMove™ tie-in.

It is used to request a SlothMove™ account for a given vault customer's conveyancing matter.

Take care to include as much accurate data as possible as SlothMove™ may reject the instruction if data is missing or corrupt.

JSON request

Parameters:
uid: the unique INTEGER reference used when creating the account (i.e. Cont ID).
fileID: your unique INTEGER reference for the conveyancing case (i.e. Matter ID).
taskID: your unique INTEGER reference to track payment.
If the customer is fully paid up when this request is posted, we trigger an action i.e call an API stating this value. Otherwise, we store this value and trigger the action when payment is recieved.
type: Either 's' or 'p' to indicate sale or purchace.
description: User to name a folder in your customer's vault for this matter.
other fields: [optional] These are self explanitory and forwarded to SlothMove™ as is, without sanity checks, care is advised.

{
  "action": "newHouseMove",
  "uid": 1001,
  "fileID": 1234, 
  "taskID": 612349, 
  "type": "p", 
  "description": "Purchace of 23 New St, Bath, BS12 4DJ", 
  "feeEarner": "Mike FeeEarner",
  "home_email": "", 
  "work_email": "Test@Test.com", 
  "main_email": "", 
  "home_phone": "", 
  "work_phone": "02234 234567",
  "main_phone": "",
    
  "old_addressLine1": "1 Test Street", 
  "old_addressLine2": "Testington", 
  "old_addressLine3": "", 
  "old_addressLine4": "",
  "old_addressLine5": "", 
  "old_addCountry": "United Kingdom", 
  "old_postcode": "TN34 3RE", 
  "old_addDXCode": "", 

  "new_addressLine1": "2 Test Street", 
  "new_addressLine2": "Testington", 
  "new_addressLine3": "", 
  "new_addressLine4": "", 
  "new_addressLine5": "", 
  "new_addCountry": "United Kingdom", 
  "new_postcode": "TN34 3RE", 
  "new_addDXCode": "" 
}

JSON response

Success:

{
  "error": "",
  "status": "success",
  "data": "-- Base64 encoded AES-256-CBC encrypted JSON --",
  "action": "newHouseMove",
  "version": "1.07",
  "proc_time": 1651428510,
  "proc_id": 86
}

"data" (decrypted)
{
  "squid_folder_id":63
}

Failure:

{
  "error": "invalid uid",
  "status": "failure",
  "data": "-- Base64 encoded AES-256-CBC encrypted JSON --",
  "action": "newHouseMove",
  "version": "1.07",
  "proc_time": 1651428362,
  "proc_id": 85
}

"data" (decrypted)
{}

Common errors

no SlothMove: Your company has no SlothMove™ tie-in.

no uid: uid missing

uid needs to be an INTEGER: The unique ID must have an integer value.

no fileID: fileID missing

fileID needs to be an INTEGER: The fileID must have an integer value.

no taskID: taskID missing

taskID needs to be an INTEGER: The taskID must have an integer value.

invalid uid: account uid unauthorised or invalid

not approved: The the user hasn't approved your access.

fileID exists: The fileID provided has already been used with this customer uid.