Close a Matter

curl --request POST \
  --url https://api.sandbox.casepathiq.com/v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}/lifecycle/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "predecessorLifecycleId": "<string>",
  "effectiveOn": "2023-12-25"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({predecessorLifecycleId: '<string>', effectiveOn: '2023-12-25'})
};

fetch('https://api.sandbox.casepathiq.com/v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}/lifecycle/close', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sandbox.casepathiq.com/v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}/lifecycle/close"

payload = {
    "predecessorLifecycleId": "<string>",
    "effectiveOn": "2023-12-25"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "clientCode": "SDCC",
  "clientReferenceId": "SDCC-2026-00482",
  "matterType": "debt_recovery",
  "parties": [
    {
      "role": "debtor",
      "type": "person",
      "isPrimaryLiable": true,
      "name": {
        "givenName": "<string>",
        "familyName": "<string>",
        "middleNames": [
          "<string>"
        ]
      },
      "addresses": [
        {
          "type": "correspondence",
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postalCode": "<string>",
          "countryCode": "IE"
        }
      ],
      "dateOfBirth": "2023-12-25",
      "customerNumber": "<string>",
      "emails": [
        {
          "address": "jsmith@example.com",
          "type": "personal",
          "isPrimary": true
        }
      ],
      "phones": [
        {
          "number": "<string>",
          "type": "mobile",
          "isPrimary": true,
          "extension": "<string>"
        }
      ]
    }
  ],
  "debt": {
    "currency": "EUR",
    "outstandingAmount": "1250.00",
    "type": "commercial_rates"
  },
  "instruction": {
    "summary": "<string>",
    "historyNotes": "<string>",
    "requestedAction": "letter_before_action"
  },
  "matterId": "<string>",
  "sourceRevisionId": "<string>",
  "lifecycleStateId": "<string>",
  "etag": "\"m1-7f3a9c2b\"",
  "status": "received",
  "intakeStatus": "needs_review",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

POST

clients

{clientCode}

matters

by-client-reference

{clientReferenceId}

lifecycle

Close a Matter

curl --request POST \
  --url https://api.sandbox.casepathiq.com/v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}/lifecycle/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "predecessorLifecycleId": "<string>",
  "effectiveOn": "2023-12-25"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({predecessorLifecycleId: '<string>', effectiveOn: '2023-12-25'})
};

fetch('https://api.sandbox.casepathiq.com/v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}/lifecycle/close', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sandbox.casepathiq.com/v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}/lifecycle/close"

payload = {
    "predecessorLifecycleId": "<string>",
    "effectiveOn": "2023-12-25"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "clientCode": "SDCC",
  "clientReferenceId": "SDCC-2026-00482",
  "matterType": "debt_recovery",
  "parties": [
    {
      "role": "debtor",
      "type": "person",
      "isPrimaryLiable": true,
      "name": {
        "givenName": "<string>",
        "familyName": "<string>",
        "middleNames": [
          "<string>"
        ]
      },
      "addresses": [
        {
          "type": "correspondence",
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postalCode": "<string>",
          "countryCode": "IE"
        }
      ],
      "dateOfBirth": "2023-12-25",
      "customerNumber": "<string>",
      "emails": [
        {
          "address": "jsmith@example.com",
          "type": "personal",
          "isPrimary": true
        }
      ],
      "phones": [
        {
          "number": "<string>",
          "type": "mobile",
          "isPrimary": true,
          "extension": "<string>"
        }
      ]
    }
  ],
  "debt": {
    "currency": "EUR",
    "outstandingAmount": "1250.00",
    "type": "commercial_rates"
  },
  "instruction": {
    "summary": "<string>",
    "historyNotes": "<string>",
    "requestedAction": "letter_before_action"
  },
  "matterId": "<string>",
  "sourceRevisionId": "<string>",
  "lifecycleStateId": "<string>",
  "etag": "\"m1-7f3a9c2b\"",
  "status": "received",
  "intakeStatus": "needs_review",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

{
  "type": "https://api.casepathiq.com/problems/usable_address_required",
  "title": "Usable address required",
  "status": 400,
  "detail": "Each Party needs exactly one usable correspondence address that meets the letter minimum.",
  "code": "usable_address_required",
  "requestId": "6f2c1b8e-3a41-4f43-9a55-6b2f0b1b7c10",
  "errors": [
    {
      "pointer": "/parties/1/addresses",
      "code": "usable_address_required"
    }
  ]
}

Authorizations

Authorization

string

header

required

Environment-specific Integration key. Never paste a live key into documentation tooling.

Path Parameters

clientCode

string

required

Granted Local Authority Client code

Pattern: ^[A-Z][A-Z0-9]{1,31}$

Example:

"SDCC"

clientReferenceId

string

required

Stable partner Matter key; must not contain personal data 1-128 characters; . and .. alone are refused.

Pattern: ^(?!\.{1,2}$)[A-Za-z0-9._-]{1,128}$

Example:

"SDCC-2026-00482"

Body

application/json

predecessorLifecycleId

string

required

reason

enum<string>

required

Available options:

satisfied,

withdrawn,

written_off,

transferred

effectiveOn

string<date>

required

Real calendar date, 2000-01-01 or later and at most 31 days after today (UTC); evidence only.

Response

Current partner-facing Matter representation

clientCode

string

required

Pattern: ^[A-Z][A-Z0-9]{1,31}$

Example:

"SDCC"

clientReferenceId

string

required

1-128 characters; . and .. alone are refused.

Pattern: ^(?!\.{1,2}$)[A-Za-z0-9._-]{1,128}$

Example:

"SDCC-2026-00482"

matterType

enum<string>

default:debt_recovery

required

The kind of legal work instructed. Optional on write; omitted means debt_recovery. Always returned.

Available options:

debt_recovery

parties

(Person party · object | Organisation party · object)[]

required

Required array length: 1 - 10 elements

One Matter Party: a Party's participation in this Matter through a Matter-specific role. Several Parties may hold the debtor role on one Matter; joint liability never multiplies the obligation, so debt.outstandingAmount remains the single Matter total.

Person party
Organisation party

Show child attributes

debt

object

required

Show child attributes

instruction

object

required

Show child attributes

matterId

string

required

sourceRevisionId

string

required

lifecycleStateId

string

required

etag

string

required

Strong entity-tag of this partner-facing representation, identical to the ETag response header. Send it back as If-Match on the next write.

Example:

"\"m1-7f3a9c2b\""

status

enum<string>

required

Available options:

received,

in_review,

active,

paused,

closed

intakeStatus

enum<string>

required

Available options:

needs_review,

ready

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

Get started

Guides

API reference

Close a Matter

Authorizations

Path Parameters

Body

Response