Skip to main content
POST
/
api
/
v2
/
cases
Create a new case
curl --request POST \
  --url https://api.example.com/api/v2/cases \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "Sale",
  "branchId": "<string>",
  "feeEarnerId": "<string>",
  "propertyPrice": 123,
  "reference": "<string>",
  "conveyancingFee": 123,
  "line_1": "<string>",
  "postcode": "<string>",
  "clients": [
    {
      "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "telephoneNumber": "<string>",
      "smsInvite": true,
      "onboardingLetters": true,
      "verificationOfFunds": true,
      "statements": true,
      "questionnaire": true,
      "sofType": "purchaser",
      "idCheckType": "standard",
      "checkProvider": "yoti",
      "ongoing": true,
      "international": true,
      "poa": true,
      "poo": true,
      "sofProvider": "upload",
      "tenantId": "<string>",
      "interestedPartyType": "<string>",
      "isGiftorOnly": true
    }
  ],
  "paymentOnAccount": 123,
  "paymentOnAccountRequired": true,
  "line_2": "<string>",
  "line_3": "<string>",
  "post_town": "<string>",
  "county": "<string>",
  "uprn": "<string>",
  "ta6_4th": true,
  "ta6_5th": true,
  "ta7_3rd": true,
  "ta7_4th": true,
  "ta9": true,
  "ta10": true
}
'
{
  "id": "<string>"
}

Body

application/json
​
type
enum<string>
required

The type of case

Available options:
Sale,
Remortgage,
Purchase
​
branchId
string
required

ID of the branch handling the case

​
feeEarnerId
string
required

ID of the fee earner assigned to the case

​
propertyPrice
number
required

Price of the property in GBP

​
reference
string
required

Case reference

​
conveyancingFee
number
required

Conveyancing fee in GBP

​
line_1
string
required

Address line 1

​
postcode
string
required

Postcode

​
clients
(Existing client · object | New client · object)[]
required

Array of clients to attach to the new case (existing or new)

Minimum array length: 1

Client object - can be either an existing client (by ID) or a new client (with details). All optional properties below apply to both existing and new clients.

​
paymentOnAccount
number

Payment on account amount

​
paymentOnAccountRequired
boolean

Whether payment on account is required

​
line_2
string

Address line 2

​
line_3
string

Address line 3

​
post_town
string

Post town

​
county
string

County

​
uprn
string

Unique Property Reference Number (optional)

​
ta6_4th
boolean

TA6 (4th) form required (Sale cases only)

​
ta6_5th
boolean

TA6 (5th) form required (Sale cases only)

​
ta7_3rd
boolean

TA7 (3rd) form required (Sale cases only)

​
ta7_4th
boolean

TA7 (4th) form required (Sale cases only)

​
ta9
boolean

TA9 form required (Sale cases only)

​
ta10
boolean

TA10 form required (Sale cases only)

Response

Case created successfully

​
id
string

The ID of the created case