Skip to main content
POST
Clear the current Source integration's pause

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

debt
object
required
instruction
object
required
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