{
"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"
}
]
}
Matters
Get a Matter by CasePath IQ ID
Resolves the Matter within the authenticated Source integration and current Client grant. Wrong-Source, manual-intake, Legal matter referral, unknown, malformed, and cross-Client identifiers return a neutral 404.
{
"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
matterId
string
required
Example:
"mat_01JEXAMPLE"
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
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"CasePath IQ API","description":"Developer documentation for the CasePath IQ Partner API.","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"api":{"playground":{"display":"simple"},"examples":{"defaults":"required","languages":["curl","javascript","python"],"prefill":false}},"banner":{"content":"**Sandbox testing.** Use https://api.sandbox.casepathiq.com with your scoped Sandbox API key. Production onboarding is separate.","dismissible":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"docket-bench","hasAudioNarration":false,"actualSubdomain":"docket-bench","customDomains":["docs.casepathiq.com"],"gitSource":{"type":"github","owner":"paypathiq","repo":"pay-path-iq-app","deployBranch":"main","contentDirectory":"apps/case-path-iq/docs/mintlify","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae1c0028e4709662983c0b0","clientVersion":"0.0.4131","searchFilterCounts":[{"language":"default","tag":"API reference","count":11},{"language":"default","tag":"Get started","count":5},{"language":"default","tag":"Guides","count":4},{"language":"default","tag":"Lifecycle","count":4},{"language":"default","tag":"Matters","count":4},{"language":"default","tag":"Payments","count":2},{"language":"default","tag":"Synchronization","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/matters/get-a-matter-by-casepath-iq-id","slug":"/api-reference/matters/get-a-matter-by-casepath-iq-id","pageMetadata":{"title":"Get a Matter by CasePath IQ ID","description":"Resolves the Matter within the authenticated Source integration and current Client grant. Wrong-Source, manual-intake, Legal matter referral, unknown, malformed, and cross-Client identifiers return a neutral 404.","deprecated":null,"version":null,"openapi":"/openapi/partner-api-v1.yaml get /v1/matters/{matterId}","href":"/api-reference/matters/get-a-matter-by-casepath-iq-id","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Resolves the Matter within the authenticated Source integration and current Client grant. Wrong-Source, manual-intake, Legal matter referral, unknown, malformed, and cross-Client identifiers return a neutral 404.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get a Matter by CasePath IQ ID","description":"Resolves the Matter within the authenticated Source integration and current Client grant. Wrong-Source, manual-intake, Legal matter referral, unknown, malformed, and cross-Client identifiers return a neutral 404.","deprecated":null,"version":null,"openapi":"/openapi/partner-api-v1.yaml get /v1/matters/{matterId}","href":"/api-reference/matters/get-a-matter-by-casepath-iq-id","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Matters"],"operationId":"getMatterById","summary":"Get a Matter by CasePath IQ ID","description":"Resolves the Matter within the authenticated Source integration and current Client grant. Wrong-Source, manual-intake, Legal matter referral, unknown, malformed, and cross-Client identifiers return a neutral 404.","parameters":["27165573-b0cd-4d5d-a5bc-1030ae397041"],"responses":{"200":"c61a7430-7cd0-4fbc-9ae3-e58101869924","400":"fcabf7c8-7a7f-4655-a307-91fbc5bdcb44","401":"3418f082-b902-43ca-97ac-99a8c85a6721","403":"a6e3d51a-8ace-42a4-8231-dc071e50e1e0","404":"2acc89c3-eb2f-40ad-a670-8c941febab2e","429":"2bb84b2d-36c4-4299-b6bc-40015d2c146c","503":"a64681d5-32b8-45c7-9696-285107bc0c81","default":"496337b1-cb35-4e77-b522-a5acd04029eb"},"method":"get","type":"path","servers":["dfc1ff98-91da-43df-927a-7196155e5ec2"],"security":["3e9f8cdf-78db-4500-bdd8-bffe721aab01"],"path":"/v1/matters/{matterId}","baseUrlOptions":["https://api.sandbox.casepathiq.com"],"title":"Get a Matter by CasePath IQ ID","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"27165573-b0cd-4d5d-a5bc-1030ae397041":{"name":"matterId","in":"path","required":true,"schema":{"type":"string","example":"mat_01JEXAMPLE","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"c61a7430-7cd0-4fbc-9ae3-e58101869924":{"description":"Current partner-facing Matter representation","headers":{"X-Request-Id":{"description":"CasePath IQ-generated support correlation identifier","schema":{"type":"string","example":"req_01JEXAMPLE"}},"Cache-Control":{"description":"Sensitive responses are not cacheable","schema":{"type":"string","const":"no-store"}},"ETag":{"description":"Strong entity-tag of the partner-facing Matter representation. It changes whenever any visible field changes — Source facts, authoritative balance, lifecycle state or intake status — not only when the Source revision advances.","schema":{"type":"string","example":"\"m1-7f3a9c2b\""}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["clientCode","clientReferenceId","matterType","parties","debt","instruction","matterId","sourceRevisionId","lifecycleStateId","etag","status","intakeStatus","createdAt","updatedAt"],"properties":{"clientCode":{"type":"string","pattern":"^[A-Z][A-Z0-9]{1,31}$","example":"SDCC","isRequired":true,"uniqueKey":"clientCode","typeLabel":"string"},"clientReferenceId":{"type":"string","pattern":"^(?!\\.{1,2}$)[A-Za-z0-9._-]{1,128}$","description":"1-128 characters; `.` and `..` alone are refused.","example":"SDCC-2026-00482","isRequired":true,"uniqueKey":"clientReferenceId","typeLabel":"string"},"matterType":{"type":"string","enum":["debt_recovery"],"default":"debt_recovery","description":"The kind of legal work instructed. Optional on write; omitted means `debt_recovery`. Always returned.","isRequired":true,"uniqueKey":"matterType","typeLabel":"enum\u003cstring>"},"parties":{"type":"array","minItems":1,"maxItems":10,"items":{"oneOf":[{"type":"object","title":"Person party","description":"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.","required":["role","type","isPrimaryLiable","name","addresses"],"properties":{"role":{"type":"string","const":"debtor","description":"Matter-specific role of this Party","isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.0.role","typeLabel":"string"},"type":{"type":"string","const":"person","isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.0.type","typeLabel":"string"},"isPrimaryLiable":{"type":"boolean","description":"Exactly one entry in `parties` must be `true`. The primary liable Party is the one the source file identifies as liable; it does not by itself select a correspondence recipient.","isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.0.isPrimaryLiable","typeLabel":"boolean"},"name":{"type":"object","additionalProperties":false,"required":["givenName","familyName"],"properties":{"givenName":{"type":"string","minLength":1,"maxLength":120,"isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.0.name.givenName","typeLabel":"string"},"familyName":{"type":"string","minLength":1,"maxLength":120,"isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.0.name.familyName","typeLabel":"string"},"middleNames":{"type":"array","maxItems":3,"items":{"type":"string","minLength":1,"maxLength":120,"uniqueKey":"parties.items.[INDEX].oneOf.0.name.middleNames.items.[INDEX]","typeLabel":"string"},"uniqueKey":"parties.items.[INDEX].oneOf.0.name.middleNames","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.0.name","typeLabel":"object"},"addresses":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"object","additionalProperties":false,"required":["type"],"description":"A create requires exactly one correspondence address with a valid IE Eircode or line1 plus city and/or state.","properties":{"type":{"type":"string","enum":["correspondence","rated_property","registered","site"],"isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.0.addresses.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"line1":{"type":"string","maxLength":512,"uniqueKey":"parties.items.[INDEX].oneOf.0.addresses.items.[INDEX].line1","typeLabel":"string"},"line2":{"type":"string","maxLength":512,"uniqueKey":"parties.items.[INDEX].oneOf.0.addresses.items.[INDEX].line2","typeLabel":"string"},"city":{"type":"string","maxLength":512,"uniqueKey":"parties.items.[INDEX].oneOf.0.addresses.items.[INDEX].city","typeLabel":"string"},"state":{"type":"string","maxLength":512,"uniqueKey":"parties.items.[INDEX].oneOf.0.addresses.items.[INDEX].state","typeLabel":"string"},"postalCode":{"type":"string","maxLength":16,"uniqueKey":"parties.items.[INDEX].oneOf.0.addresses.items.[INDEX].postalCode","typeLabel":"string"},"countryCode":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"default":"IE","uniqueKey":"parties.items.[INDEX].oneOf.0.addresses.items.[INDEX].countryCode","typeLabel":"enum\u003cstring>"}},"uniqueKey":"parties.items.[INDEX].oneOf.0.addresses.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.0.addresses","typeLabel":"object[]"},"dateOfBirth":{"type":"string","format":"date","description":"Optional, from 1900-01-01 to today. Used to confirm identity; never returned in sync items.","uniqueKey":"parties.items.[INDEX].oneOf.0.dateOfBirth","typeLabel":"string\u003cdate>"},"customerNumber":{"type":"string","maxLength":512,"uniqueKey":"parties.items.[INDEX].oneOf.0.customerNumber","typeLabel":"string"},"emails":{"type":"array","maxItems":10,"description":"At most one email may be primary; the others are secondary contacts.","items":{"type":"object","additionalProperties":false,"required":["address","type","isPrimary"],"properties":{"address":{"type":"string","format":"email","maxLength":254,"isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.0.emails.items.[INDEX].address","typeLabel":"string\u003cemail>"},"type":{"type":"string","enum":["personal","work","other"],"isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.0.emails.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"isPrimary":{"type":"boolean","isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.0.emails.items.[INDEX].isPrimary","typeLabel":"boolean"}},"uniqueKey":"parties.items.[INDEX].oneOf.0.emails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"parties.items.[INDEX].oneOf.0.emails","typeLabel":"object[]"},"phones":{"type":"array","maxItems":10,"description":"At most one phone number may be primary; the others are secondary contacts. A number may repeat only with a different extension.","items":{"type":"object","additionalProperties":false,"required":["number","type","isPrimary"],"properties":{"number":{"type":"string","pattern":"^\\+[1-9]\\d{7,14}$","isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.0.phones.items.[INDEX].number","typeLabel":"string"},"type":{"type":"string","enum":["mobile","landline","work","other"],"isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.0.phones.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"isPrimary":{"type":"boolean","isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.0.phones.items.[INDEX].isPrimary","typeLabel":"boolean"},"extension":{"type":"string","pattern":"^[0-9]{1,6}$","description":"Optional extension for a landline or work number.","uniqueKey":"parties.items.[INDEX].oneOf.0.phones.items.[INDEX].extension","typeLabel":"string"}},"uniqueKey":"parties.items.[INDEX].oneOf.0.phones.items.[INDEX]","typeLabel":"object"},"uniqueKey":"parties.items.[INDEX].oneOf.0.phones","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"parties.items.[INDEX].oneOf.0","typeLabel":"Person party · object"},{"type":"object","title":"Organisation party","description":"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.","required":["role","type","isPrimaryLiable","legalName","addresses"],"properties":{"role":{"type":"string","const":"debtor","description":"Matter-specific role of this Party","isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.1.role","typeLabel":"string"},"type":{"type":"string","const":"organisation","isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.1.type","typeLabel":"string"},"isPrimaryLiable":{"type":"boolean","description":"Exactly one entry in `parties` must be `true`.","isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.1.isPrimaryLiable","typeLabel":"boolean"},"legalName":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.1.legalName","typeLabel":"string"},"addresses":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"object","additionalProperties":false,"required":["type"],"description":"A create requires exactly one correspondence address with a valid IE Eircode or line1 plus city and/or state.","properties":{"type":{"type":"string","enum":["correspondence","rated_property","registered","site"],"isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.1.addresses.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"line1":{"type":"string","maxLength":512,"uniqueKey":"parties.items.[INDEX].oneOf.1.addresses.items.[INDEX].line1","typeLabel":"string"},"line2":{"type":"string","maxLength":512,"uniqueKey":"parties.items.[INDEX].oneOf.1.addresses.items.[INDEX].line2","typeLabel":"string"},"city":{"type":"string","maxLength":512,"uniqueKey":"parties.items.[INDEX].oneOf.1.addresses.items.[INDEX].city","typeLabel":"string"},"state":{"type":"string","maxLength":512,"uniqueKey":"parties.items.[INDEX].oneOf.1.addresses.items.[INDEX].state","typeLabel":"string"},"postalCode":{"type":"string","maxLength":16,"uniqueKey":"parties.items.[INDEX].oneOf.1.addresses.items.[INDEX].postalCode","typeLabel":"string"},"countryCode":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"default":"IE","uniqueKey":"parties.items.[INDEX].oneOf.1.addresses.items.[INDEX].countryCode","typeLabel":"enum\u003cstring>"}},"uniqueKey":"parties.items.[INDEX].oneOf.1.addresses.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.1.addresses","typeLabel":"object[]"},"companyNumber":{"type":"string","pattern":"^[A-Za-z0-9]{1,20}$","description":"Optional company registration number, for example a CRO number.","uniqueKey":"parties.items.[INDEX].oneOf.1.companyNumber","typeLabel":"string"},"tradingNames":{"type":"array","maxItems":5,"default":[],"description":"Names the organisation trades under, besides its legal name.","items":{"type":"string","minLength":1,"maxLength":200,"uniqueKey":"parties.items.[INDEX].oneOf.1.tradingNames.items.[INDEX]","typeLabel":"string"},"uniqueKey":"parties.items.[INDEX].oneOf.1.tradingNames","typeLabel":"string[]"},"customerNumber":{"type":"string","maxLength":512,"uniqueKey":"parties.items.[INDEX].oneOf.1.customerNumber","typeLabel":"string"},"emails":{"type":"array","maxItems":10,"description":"At most one email may be primary; the others are secondary contacts.","items":{"type":"object","additionalProperties":false,"required":["address","type","isPrimary"],"properties":{"address":{"type":"string","format":"email","maxLength":254,"isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.1.emails.items.[INDEX].address","typeLabel":"string\u003cemail>"},"type":{"type":"string","enum":["personal","work","other"],"isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.1.emails.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"isPrimary":{"type":"boolean","isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.1.emails.items.[INDEX].isPrimary","typeLabel":"boolean"}},"uniqueKey":"parties.items.[INDEX].oneOf.1.emails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"parties.items.[INDEX].oneOf.1.emails","typeLabel":"object[]"},"phones":{"type":"array","maxItems":10,"description":"At most one phone number may be primary; the others are secondary contacts. A number may repeat only with a different extension.","items":{"type":"object","additionalProperties":false,"required":["number","type","isPrimary"],"properties":{"number":{"type":"string","pattern":"^\\+[1-9]\\d{7,14}$","isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.1.phones.items.[INDEX].number","typeLabel":"string"},"type":{"type":"string","enum":["mobile","landline","work","other"],"isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.1.phones.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"isPrimary":{"type":"boolean","isRequired":true,"uniqueKey":"parties.items.[INDEX].oneOf.1.phones.items.[INDEX].isPrimary","typeLabel":"boolean"},"extension":{"type":"string","pattern":"^[0-9]{1,6}$","description":"Optional extension for a landline or work number.","uniqueKey":"parties.items.[INDEX].oneOf.1.phones.items.[INDEX].extension","typeLabel":"string"}},"uniqueKey":"parties.items.[INDEX].oneOf.1.phones.items.[INDEX]","typeLabel":"object"},"uniqueKey":"parties.items.[INDEX].oneOf.1.phones","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"parties.items.[INDEX].oneOf.1","typeLabel":"Organisation party · object"}],"uniqueKey":"parties.items.[INDEX]","typeLabel":"Person party · object | Organisation party · object"},"isRequired":true,"uniqueKey":"parties","typeLabel":"(Person party · object | Organisation party · object)[]"},"debt":{"type":"object","additionalProperties":false,"required":["currency","outstandingAmount"],"properties":{"currency":{"type":"string","pattern":"^[A-Z]{3}$","example":"EUR","isRequired":true,"uniqueKey":"debt.currency","typeLabel":"string"},"outstandingAmount":{"type":"string","pattern":"^(0|[1-9][0-9]*)\\.[0-9]{2}$","maxLength":15,"example":"1250.00","isRequired":true,"uniqueKey":"debt.outstandingAmount","typeLabel":"string"},"type":{"type":"string","enum":["commercial_rates","rent_arrears","housing_loan","other"],"description":"The kind of debt being recovered. Optional.","uniqueKey":"debt.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"debt","typeLabel":"object"},"instruction":{"type":"object","additionalProperties":false,"properties":{"summary":{"type":"string","maxLength":2000,"uniqueKey":"instruction.summary","typeLabel":"string"},"historyNotes":{"type":"string","maxLength":10000,"uniqueKey":"instruction.historyNotes","typeLabel":"string"},"requestedAction":{"type":"string","enum":["letter_before_action","issue_proceedings","review_only"],"uniqueKey":"instruction.requestedAction","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"instruction","typeLabel":"object"},"matterId":{"type":"string","isRequired":true,"uniqueKey":"matterId","typeLabel":"string"},"sourceRevisionId":{"type":"string","isRequired":true,"uniqueKey":"sourceRevisionId","typeLabel":"string"},"lifecycleStateId":{"type":"string","isRequired":true,"uniqueKey":"lifecycleStateId","typeLabel":"string"},"etag":{"type":"string","description":"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\"","isRequired":true,"uniqueKey":"etag","typeLabel":"string"},"status":{"type":"string","enum":["received","in_review","active","paused","closed"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"intakeStatus":{"type":"string","enum":["needs_review","ready"],"isRequired":true,"uniqueKey":"intakeStatus","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"clientCode":"SDCC","clientReferenceId":"SDCC-2026-00482","matterType":"debt_recovery","parties":[{"role":"debtor","type":"person","isPrimaryLiable":true,"name":{"givenName":"\u003cstring>","familyName":"\u003cstring>","middleNames":["\u003cstring>"]},"addresses":[{"type":"correspondence","line1":"\u003cstring>","line2":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","postalCode":"\u003cstring>","countryCode":"IE"}],"dateOfBirth":"2023-12-25","customerNumber":"\u003cstring>","emails":[{"address":"jsmith@example.com","type":"personal","isPrimary":true}],"phones":[{"number":"\u003cstring>","type":"mobile","isPrimary":true,"extension":"\u003cstring>"}]}],"debt":{"currency":"EUR","outstandingAmount":"1250.00","type":"commercial_rates"},"instruction":{"summary":"\u003cstring>","historyNotes":"\u003cstring>","requestedAction":"letter_before_action"},"matterId":"\u003cstring>","sourceRevisionId":"\u003cstring>","lifecycleStateId":"\u003cstring>","etag":"\"m1-7f3a9c2b\"","status":"received","intakeStatus":"needs_review","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"fcabf7c8-7a7f-4655-a307-91fbc5bdcb44":{"description":"Validation, schema, enum, money or letter-minimum failure","headers":{"X-Request-Id":{"description":"CasePath IQ-generated support correlation identifier","schema":{"type":"string","example":"req_01JEXAMPLE"}},"Cache-Control":{"description":"Sensitive responses are not cacheable","schema":{"type":"string","const":"no-store"}}},"content":{"application/problem+json":{"schema":{"type":"object","additionalProperties":false,"required":["type","title","status","detail","code"],"properties":{"type":{"type":"string","format":"uri-reference","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":400,"maximum":599,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code. Client software branches on this value; it never parses detail. The same codes appear in `errors[].code`, where field-level codes such as required_field, unknown_field and unsupported_enum point at what to correct.","enum":["balance_mismatch","capacity_limited","card_number_detected","client_not_configured","client_scope_denied","currency_mismatch","effective_date_out_of_range","identity_mismatch","invalid_credentials","invalid_field","invalid_page_token","invalid_precondition","invalid_request","invisible_character","matter_closed","method_not_allowed","not_found","opening_balance_change_not_allowed","partner_writes_paused","payload_too_large","payment_observation_conflict","precondition_failed","precondition_required","primary_liable_party_required","rate_limited","recipient_rebind_required","request_timeout","required_field","source_write_conflict","stale_lifecycle_precondition","stale_lifecycle_retry","unavailable","unknown_field","unprocessable_entity","unsupported_enum","unsupported_media_type","usable_address_required"],"example":"client_scope_denied","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"instance":{"type":"string","format":"uri-reference","description":"Optional server-issued opaque occurrence URI; never contains request path or query values, or partner identifiers","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"},"requestId":{"type":"string","description":"Equals the `X-Request-Id` header. Present on every application response; absent only on a `rate_limited` response answered by the network edge before the request reaches the application.","conditionalRequirements":[{"when":[[{"property":"code","values":["rate_limited"]}]],"negated":true}],"uniqueKey":"requestId","typeLabel":"string"},"errors":{"type":"array","maxItems":50,"description":"At most 50 field-level entries, in the order found.","items":{"type":"object","additionalProperties":false,"required":["pointer","code"],"properties":{"pointer":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"example":{"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"}]},"conditionallyRequiredProperties":{"requestId":[{"when":[[{"property":"code","values":["rate_limited"]}]],"negated":true}]},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"3418f082-b902-43ca-97ac-99a8c85a6721":{"description":"Missing, malformed, expired, revoked or unknown partner key, an invalid edge identity, or a network address outside the key's allowed ranges (invalid_credentials). The same neutral 401 is returned for every cause.","headers":{"X-Request-Id":{"description":"CasePath IQ-generated support correlation identifier","schema":{"type":"string","example":"req_01JEXAMPLE"}},"Cache-Control":{"description":"Sensitive responses are not cacheable","schema":{"type":"string","const":"no-store"}}},"content":{"application/problem+json":{"schema":{"type":"object","additionalProperties":false,"required":["type","title","status","detail","code"],"properties":{"type":{"type":"string","format":"uri-reference","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":400,"maximum":599,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code. Client software branches on this value; it never parses detail. The same codes appear in `errors[].code`, where field-level codes such as required_field, unknown_field and unsupported_enum point at what to correct.","enum":["balance_mismatch","capacity_limited","card_number_detected","client_not_configured","client_scope_denied","currency_mismatch","effective_date_out_of_range","identity_mismatch","invalid_credentials","invalid_field","invalid_page_token","invalid_precondition","invalid_request","invisible_character","matter_closed","method_not_allowed","not_found","opening_balance_change_not_allowed","partner_writes_paused","payload_too_large","payment_observation_conflict","precondition_failed","precondition_required","primary_liable_party_required","rate_limited","recipient_rebind_required","request_timeout","required_field","source_write_conflict","stale_lifecycle_precondition","stale_lifecycle_retry","unavailable","unknown_field","unprocessable_entity","unsupported_enum","unsupported_media_type","usable_address_required"],"example":"client_scope_denied","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"instance":{"type":"string","format":"uri-reference","description":"Optional server-issued opaque occurrence URI; never contains request path or query values, or partner identifiers","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"},"requestId":{"type":"string","description":"Equals the `X-Request-Id` header. Present on every application response; absent only on a `rate_limited` response answered by the network edge before the request reaches the application.","conditionalRequirements":[{"when":[[{"property":"code","values":["rate_limited"]}]],"negated":true}],"uniqueKey":"requestId","typeLabel":"string"},"errors":{"type":"array","maxItems":50,"description":"At most 50 field-level entries, in the order found.","items":{"type":"object","additionalProperties":false,"required":["pointer","code"],"properties":{"pointer":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"example":{"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"}]},"conditionallyRequiredProperties":{"requestId":[{"when":[[{"property":"code","values":["rate_limited"]}]],"negated":true}]},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"a6e3d51a-8ace-42a4-8231-dc071e50e1e0":{"description":"The key cannot act for this Client code (client_scope_denied). Unknown, ungranted and key-restricted Client codes share this response.","headers":{"X-Request-Id":{"description":"CasePath IQ-generated support correlation identifier","schema":{"type":"string","example":"req_01JEXAMPLE"}},"Cache-Control":{"description":"Sensitive responses are not cacheable","schema":{"type":"string","const":"no-store"}}},"content":{"application/problem+json":{"schema":{"type":"object","additionalProperties":false,"required":["type","title","status","detail","code"],"properties":{"type":{"type":"string","format":"uri-reference","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":400,"maximum":599,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code. Client software branches on this value; it never parses detail. The same codes appear in `errors[].code`, where field-level codes such as required_field, unknown_field and unsupported_enum point at what to correct.","enum":["balance_mismatch","capacity_limited","card_number_detected","client_not_configured","client_scope_denied","currency_mismatch","effective_date_out_of_range","identity_mismatch","invalid_credentials","invalid_field","invalid_page_token","invalid_precondition","invalid_request","invisible_character","matter_closed","method_not_allowed","not_found","opening_balance_change_not_allowed","partner_writes_paused","payload_too_large","payment_observation_conflict","precondition_failed","precondition_required","primary_liable_party_required","rate_limited","recipient_rebind_required","request_timeout","required_field","source_write_conflict","stale_lifecycle_precondition","stale_lifecycle_retry","unavailable","unknown_field","unprocessable_entity","unsupported_enum","unsupported_media_type","usable_address_required"],"example":"client_scope_denied","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"instance":{"type":"string","format":"uri-reference","description":"Optional server-issued opaque occurrence URI; never contains request path or query values, or partner identifiers","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"},"requestId":{"type":"string","description":"Equals the `X-Request-Id` header. Present on every application response; absent only on a `rate_limited` response answered by the network edge before the request reaches the application.","conditionalRequirements":[{"when":[[{"property":"code","values":["rate_limited"]}]],"negated":true}],"uniqueKey":"requestId","typeLabel":"string"},"errors":{"type":"array","maxItems":50,"description":"At most 50 field-level entries, in the order found.","items":{"type":"object","additionalProperties":false,"required":["pointer","code"],"properties":{"pointer":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"example":{"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"}]},"conditionallyRequiredProperties":{"requestId":[{"when":[[{"property":"code","values":["rate_limited"]}]],"negated":true}]},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"2acc89c3-eb2f-40ad-a670-8c941febab2e":{"description":"No such Matter or Payment observation in this scope (neutral)","headers":{"X-Request-Id":{"description":"CasePath IQ-generated support correlation identifier","schema":{"type":"string","example":"req_01JEXAMPLE"}},"Cache-Control":{"description":"Sensitive responses are not cacheable","schema":{"type":"string","const":"no-store"}}},"content":{"application/problem+json":{"schema":{"type":"object","additionalProperties":false,"required":["type","title","status","detail","code"],"properties":{"type":{"type":"string","format":"uri-reference","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":400,"maximum":599,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code. Client software branches on this value; it never parses detail. The same codes appear in `errors[].code`, where field-level codes such as required_field, unknown_field and unsupported_enum point at what to correct.","enum":["balance_mismatch","capacity_limited","card_number_detected","client_not_configured","client_scope_denied","currency_mismatch","effective_date_out_of_range","identity_mismatch","invalid_credentials","invalid_field","invalid_page_token","invalid_precondition","invalid_request","invisible_character","matter_closed","method_not_allowed","not_found","opening_balance_change_not_allowed","partner_writes_paused","payload_too_large","payment_observation_conflict","precondition_failed","precondition_required","primary_liable_party_required","rate_limited","recipient_rebind_required","request_timeout","required_field","source_write_conflict","stale_lifecycle_precondition","stale_lifecycle_retry","unavailable","unknown_field","unprocessable_entity","unsupported_enum","unsupported_media_type","usable_address_required"],"example":"client_scope_denied","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"instance":{"type":"string","format":"uri-reference","description":"Optional server-issued opaque occurrence URI; never contains request path or query values, or partner identifiers","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"},"requestId":{"type":"string","description":"Equals the `X-Request-Id` header. Present on every application response; absent only on a `rate_limited` response answered by the network edge before the request reaches the application.","conditionalRequirements":[{"when":[[{"property":"code","values":["rate_limited"]}]],"negated":true}],"uniqueKey":"requestId","typeLabel":"string"},"errors":{"type":"array","maxItems":50,"description":"At most 50 field-level entries, in the order found.","items":{"type":"object","additionalProperties":false,"required":["pointer","code"],"properties":{"pointer":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"example":{"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"}]},"conditionallyRequiredProperties":{"requestId":[{"when":[[{"property":"code","values":["rate_limited"]}]],"negated":true}]},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"2bb84b2d-36c4-4299-b6bc-40015d2c146c":{"description":"Per-key rate limit (rate_limited), per-Matter daily write cap or pilot capacity limit (capacity_limited). Wait for Retry-After before retrying.","headers":{"X-Request-Id":{"description":"CasePath IQ-generated support correlation identifier","schema":{"type":"string","example":"req_01JEXAMPLE"}},"Cache-Control":{"description":"Sensitive responses are not cacheable","schema":{"type":"string","const":"no-store"}},"Retry-After":{"description":"Seconds to wait before retrying this request","schema":{"type":"integer","minimum":1},"example":30}},"content":{"application/problem+json":{"schema":{"type":"object","additionalProperties":false,"required":["type","title","status","detail","code"],"properties":{"type":{"type":"string","format":"uri-reference","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":400,"maximum":599,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code. Client software branches on this value; it never parses detail. The same codes appear in `errors[].code`, where field-level codes such as required_field, unknown_field and unsupported_enum point at what to correct.","enum":["balance_mismatch","capacity_limited","card_number_detected","client_not_configured","client_scope_denied","currency_mismatch","effective_date_out_of_range","identity_mismatch","invalid_credentials","invalid_field","invalid_page_token","invalid_precondition","invalid_request","invisible_character","matter_closed","method_not_allowed","not_found","opening_balance_change_not_allowed","partner_writes_paused","payload_too_large","payment_observation_conflict","precondition_failed","precondition_required","primary_liable_party_required","rate_limited","recipient_rebind_required","request_timeout","required_field","source_write_conflict","stale_lifecycle_precondition","stale_lifecycle_retry","unavailable","unknown_field","unprocessable_entity","unsupported_enum","unsupported_media_type","usable_address_required"],"example":"client_scope_denied","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"instance":{"type":"string","format":"uri-reference","description":"Optional server-issued opaque occurrence URI; never contains request path or query values, or partner identifiers","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"},"requestId":{"type":"string","description":"Equals the `X-Request-Id` header. Present on every application response; absent only on a `rate_limited` response answered by the network edge before the request reaches the application.","conditionalRequirements":[{"when":[[{"property":"code","values":["rate_limited"]}]],"negated":true}],"uniqueKey":"requestId","typeLabel":"string"},"errors":{"type":"array","maxItems":50,"description":"At most 50 field-level entries, in the order found.","items":{"type":"object","additionalProperties":false,"required":["pointer","code"],"properties":{"pointer":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"example":{"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"}]},"conditionallyRequiredProperties":{"requestId":[{"when":[[{"property":"code","values":["rate_limited"]}]],"negated":true}]},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"a64681d5-32b8-45c7-9696-285107bc0c81":{"description":"Transient or fenced failure (unavailable), or Partner API writes paused by the platform (partner_writes_paused; reads still work). Retry unchanged content after Retry-After.","headers":{"X-Request-Id":{"description":"CasePath IQ-generated support correlation identifier","schema":{"type":"string","example":"req_01JEXAMPLE"}},"Cache-Control":{"description":"Sensitive responses are not cacheable","schema":{"type":"string","const":"no-store"}},"Retry-After":{"description":"Seconds to wait before retrying this request","schema":{"type":"integer","minimum":1},"example":30}},"content":{"application/problem+json":{"schema":{"type":"object","additionalProperties":false,"required":["type","title","status","detail","code"],"properties":{"type":{"type":"string","format":"uri-reference","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":400,"maximum":599,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code. Client software branches on this value; it never parses detail. The same codes appear in `errors[].code`, where field-level codes such as required_field, unknown_field and unsupported_enum point at what to correct.","enum":["balance_mismatch","capacity_limited","card_number_detected","client_not_configured","client_scope_denied","currency_mismatch","effective_date_out_of_range","identity_mismatch","invalid_credentials","invalid_field","invalid_page_token","invalid_precondition","invalid_request","invisible_character","matter_closed","method_not_allowed","not_found","opening_balance_change_not_allowed","partner_writes_paused","payload_too_large","payment_observation_conflict","precondition_failed","precondition_required","primary_liable_party_required","rate_limited","recipient_rebind_required","request_timeout","required_field","source_write_conflict","stale_lifecycle_precondition","stale_lifecycle_retry","unavailable","unknown_field","unprocessable_entity","unsupported_enum","unsupported_media_type","usable_address_required"],"example":"client_scope_denied","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"instance":{"type":"string","format":"uri-reference","description":"Optional server-issued opaque occurrence URI; never contains request path or query values, or partner identifiers","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"},"requestId":{"type":"string","description":"Equals the `X-Request-Id` header. Present on every application response; absent only on a `rate_limited` response answered by the network edge before the request reaches the application.","conditionalRequirements":[{"when":[[{"property":"code","values":["rate_limited"]}]],"negated":true}],"uniqueKey":"requestId","typeLabel":"string"},"errors":{"type":"array","maxItems":50,"description":"At most 50 field-level entries, in the order found.","items":{"type":"object","additionalProperties":false,"required":["pointer","code"],"properties":{"pointer":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"example":{"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"}]},"conditionallyRequiredProperties":{"requestId":[{"when":[[{"property":"code","values":["rate_limited"]}]],"negated":true}]},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"496337b1-cb35-4e77-b522-a5acd04029eb":{"description":"RFC 9457 Problem Details error","headers":{"X-Request-Id":{"description":"CasePath IQ-generated support correlation identifier","schema":{"type":"string","example":"req_01JEXAMPLE"}},"Cache-Control":{"description":"Sensitive responses are not cacheable","schema":{"type":"string","const":"no-store"}}},"content":{"application/problem+json":{"schema":{"type":"object","additionalProperties":false,"required":["type","title","status","detail","code"],"properties":{"type":{"type":"string","format":"uri-reference","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi-reference>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":400,"maximum":599,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code. Client software branches on this value; it never parses detail. The same codes appear in `errors[].code`, where field-level codes such as required_field, unknown_field and unsupported_enum point at what to correct.","enum":["balance_mismatch","capacity_limited","card_number_detected","client_not_configured","client_scope_denied","currency_mismatch","effective_date_out_of_range","identity_mismatch","invalid_credentials","invalid_field","invalid_page_token","invalid_precondition","invalid_request","invisible_character","matter_closed","method_not_allowed","not_found","opening_balance_change_not_allowed","partner_writes_paused","payload_too_large","payment_observation_conflict","precondition_failed","precondition_required","primary_liable_party_required","rate_limited","recipient_rebind_required","request_timeout","required_field","source_write_conflict","stale_lifecycle_precondition","stale_lifecycle_retry","unavailable","unknown_field","unprocessable_entity","unsupported_enum","unsupported_media_type","usable_address_required"],"example":"client_scope_denied","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"instance":{"type":"string","format":"uri-reference","description":"Optional server-issued opaque occurrence URI; never contains request path or query values, or partner identifiers","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"},"requestId":{"type":"string","description":"Equals the `X-Request-Id` header. Present on every application response; absent only on a `rate_limited` response answered by the network edge before the request reaches the application.","conditionalRequirements":[{"when":[[{"property":"code","values":["rate_limited"]}]],"negated":true}],"uniqueKey":"requestId","typeLabel":"string"},"errors":{"type":"array","maxItems":50,"description":"At most 50 field-level entries, in the order found.","items":{"type":"object","additionalProperties":false,"required":["pointer","code"],"properties":{"pointer":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"example":{"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"}]},"conditionallyRequiredProperties":{"requestId":[{"when":[[{"property":"code","values":["rate_limited"]}]],"negated":true}]},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3e9f8cdf-78db-4500-bdd8-bffe721aab01":{"PartnerKey":{"type":"http","scheme":"bearer","bearerFormat":"CasePath IQ partner key","description":"Environment-specific Integration key. Never paste a live key into documentation tooling.","scopes":[],"schemeName":"PartnerKey"}}},"servers":{"dfc1ff98-91da-43df-927a-7196155e5ec2":{"url":"https://api.sandbox.casepathiq.com","description":"Sandbox testing"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"CasePath IQ partner key","description":"Environment-specific Integration key. Never paste a live key into documentation tooling.","scopes":[],"schemeName":"PartnerKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Environment-specific Integration key. Never paste a live key into documentation tooling.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"PartnerKey","name":"Authorization"}],"title":"PartnerKey"}]},"originalFileLocation":"openapi/partner-api-v1.yaml"},"subdomain":"docket-bench","siteName":"CasePath IQ API","title":"Get a Matter by CasePath IQ ID - CasePath IQ API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T09:27:35.735Z","originalFileLocation":"api-reference/matters/get-a-matter-by-casepath-iq-id.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Resolves the Matter within the authenticated Source integration and current Client grant. Wrong-Source, manual-intake, Legal matter referral, unknown, malformed, and cross-Client identifiers return a neutral 404.\">\u003cmeta data-mint-head name=\"application-name\" content=\"CasePath IQ API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/docket-bench/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/docket-bench/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/docket-bench/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/docket-bench/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a Matter by CasePath IQ ID - CasePath IQ API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Resolves the Matter within the authenticated Source integration and current Client grant. Wrong-Source, manual-intake, Legal matter referral, unknown, malformed, and cross-Client identifiers return a neutral 404.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CasePath IQ API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.casepathiq.com/api-reference/matters/get-a-matter-by-casepath-iq-id\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docket-bench.mintlify.site/_mintlify/api/og/v2?division=Matters\u0026amp;title=Get+a+Matter+by+CasePath+IQ+ID\u0026amp;description=Resolves+the+Matter+within+the+authenticated+Source+integration+and+current+Client+grant.+Wrong-Source%2C+manual-intake%2C+Legal+matter+referral%2C+unknown%2C+malformed\u0026amp;theme=be394bdd824f66fd2549706a\u0026amp;signature=0e803e70a723265ad6acdb6ebd3639a17672d665aca3b0e8b9ce779af7b369c5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get a Matter by CasePath IQ ID - CasePath IQ API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Resolves the Matter within the authenticated Source integration and current Client grant. Wrong-Source, manual-intake, Legal matter referral, unknown, malformed, and cross-Client identifiers return a neutral 404.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docket-bench.mintlify.site/_mintlify/api/og/v2?division=Matters\u0026amp;title=Get+a+Matter+by+CasePath+IQ+ID\u0026amp;description=Resolves+the+Matter+within+the+authenticated+Source+integration+and+current+Client+grant.+Wrong-Source%2C+manual-intake%2C+Legal+matter+referral%2C+unknown%2C+malformed\u0026amp;theme=be394bdd824f66fd2549706a\u0026amp;signature=0e803e70a723265ad6acdb6ebd3639a17672d665aca3b0e8b9ce779af7b369c5\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/docket-bench/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"CasePath IQ API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.casepathiq.com/api-reference/matters/get-a-matter-by-casepath-iq-id\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/matters/get-a-matter-by-casepath-iq-id.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.casepathiq.com/#organization\",\"name\":\"CasePath IQ API\",\"url\":\"https://docs.casepathiq.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.casepathiq.com#website\",\"name\":\"CasePath IQ API\",\"url\":\"https://docs.casepathiq.com\",\"publisher\":{\"@id\":\"https://docs.casepathiq.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.casepathiq.com/api-reference/matters/get-a-matter-by-casepath-iq-id#webpage\",\"url\":\"https://docs.casepathiq.com/api-reference/matters/get-a-matter-by-casepath-iq-id\",\"name\":\"Get a Matter by CasePath IQ ID\",\"description\":\"Resolves the Matter within the authenticated Source integration and current Client grant. Wrong-Source, manual-intake, Legal matter referral, unknown, malformed, and cross-Client identifiers return a neutral 404.\",\"dateModified\":\"2026-10-28T09:27:35.735Z\",\"isPartOf\":{\"@id\":\"https://docs.casepathiq.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.casepathiq.com/api-reference/matters/get-a-matter-by-casepath-iq-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.casepathiq.com/api-reference/matters/get-a-matter-by-casepath-iq-id#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.casepathiq.com/api-reference/matters/get-a-matter-by-client-reference-id\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Matters\",\"item\":\"https://docs.casepathiq.com/api-reference/matters/get-a-matter-by-client-reference-id\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a Matter by CasePath IQ ID\",\"item\":\"https://docs.casepathiq.com/api-reference/matters/get-a-matter-by-casepath-iq-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.casepathiq.com/api-reference/matters/get-a-matter-by-casepath-iq-id#apireference\",\"headline\":\"Get a Matter by CasePath IQ ID\",\"name\":\"Get a Matter by CasePath IQ ID\",\"description\":\"Resolves the Matter within the authenticated Source integration and current Client grant. Wrong-Source, manual-intake, Legal matter referral, unknown, malformed, and cross-Client identifiers return a neutral 404.\",\"url\":\"https://docs.casepathiq.com/api-reference/matters/get-a-matter-by-casepath-iq-id\",\"mainEntityOfPage\":{\"@id\":\"https://docs.casepathiq.com/api-reference/matters/get-a-matter-by-casepath-iq-id#webpage\"},\"dateModified\":\"2026-10-28T09:27:35.735Z\",\"publisher\":{\"@id\":\"https://docs.casepathiq.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.casepathiq.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"CasePath IQ API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"CasePath IQ API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/matters/get-a-matter-by-casepath-iq-id.md","siteName":"CasePath IQ API","nav":{"global":null,"groups":[{"group":"Get started","icon":"rocket","pages":[{"title":"CasePath IQ Partner API","sidebarTitle":"Overview","icon":"book-open","tag":"Sandbox","href":"/index"},{"title":"Plan your integration","sidebarTitle":"Plan your integration","icon":"clipboard-list","href":"/integration-planning"},{"title":"Core concepts","sidebarTitle":"Concepts","icon":"boxes-stacked","href":"/concepts"},{"title":"Authentication and environments","sidebarTitle":"Authentication","icon":"key","href":"/authentication"},{"title":"Quickstart","sidebarTitle":"Quickstart","icon":"rocket","href":"/quickstart"}]},{"group":"Guides","icon":"book-open","pages":[{"title":"Matter placement and updates","sidebarTitle":"Matters","icon":"scale-balanced","href":"/matters"},{"title":"Incremental synchronization","sidebarTitle":"Synchronization","icon":"arrows-rotate","href":"/synchronization"},{"title":"Payments, corrections, and lifecycle","sidebarTitle":"Payments and lifecycle","icon":"money-check-dollar","href":"/payments-and-lifecycle"},{"title":"Errors and safe retries","sidebarTitle":"Errors and retries","icon":"triangle-exclamation","href":"/errors-and-retries"}]},{"group":"API reference","pages":[{"group":"Matters","pages":[{"title":"Get a Matter by client reference ID","deprecated":null,"version":null,"openapi":"/openapi/partner-api-v1.yaml get /v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}","href":"/api-reference/matters/get-a-matter-by-client-reference-id"},{"title":"Place or replace a Matter","deprecated":null,"version":null,"openapi":"/openapi/partner-api-v1.yaml put /v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}","href":"/api-reference/matters/place-or-replace-a-matter"},{"title":"Patch a Matter","description":"Applies a closed JSON Merge Patch to Integration-owned fields. PATCH never creates a Matter and cannot change debt currency or amount. `parties` replaces the whole collection, so a patch that changes any Party's identity must carry complete recipient collections for every Party it sends.\n\nPATCH requires `If-Match: \u003cetag>`; a missing precondition returns `428` and a stale one returns `412`, in both cases without mutation.","deprecated":null,"version":null,"openapi":"/openapi/partner-api-v1.yaml patch /v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}","href":"/api-reference/matters/patch-a-matter"},{"title":"Get a Matter by CasePath IQ ID","deprecated":null,"version":null,"openapi":"/openapi/partner-api-v1.yaml get /v1/matters/{matterId}","href":"/api-reference/matters/get-a-matter-by-casepath-iq-id"}]},{"group":"Synchronization","pages":[{"title":"List Matters changed since a timestamp","description":"Returns a minimized current-state projection, not an event log. Results are restricted to the authenticated Source integration and current Client grant.\n\nThe final page carries `syncedThrough`: the UTC instant this run is guaranteed to have covered. Pass it as the next run's `updatedSince`. Callers never derive a boundary from their own clock or from the greatest `updatedAt` returned.","deprecated":null,"version":null,"openapi":"/openapi/partner-api-v1.yaml get /v1/matters","href":"/api-reference/synchronization/list-matters-changed-since-a-timestamp"}]},{"group":"Payments","pages":[{"title":"Get a Payment observation","deprecated":null,"version":null,"openapi":"/openapi/partner-api-v1.yaml get /v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}/payment-observations/{externalPaymentId}","href":"/api-reference/payments/get-a-payment-observation"},{"title":"Record a Payment observation","deprecated":null,"version":null,"openapi":"/openapi/partner-api-v1.yaml put /v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}/payment-observations/{externalPaymentId}","href":"/api-reference/payments/record-a-payment-observation"}]},{"group":"Lifecycle","pages":[{"title":"Pause a Matter","deprecated":null,"version":null,"openapi":"/openapi/partner-api-v1.yaml post /v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}/lifecycle/pause","href":"/api-reference/lifecycle/pause-a-matter"},{"title":"Clear the current Source integration's pause","deprecated":null,"version":null,"openapi":"/openapi/partner-api-v1.yaml post /v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}/lifecycle/clear-pause","href":"/api-reference/lifecycle/clear-the-current-source-integrations-pause"},{"title":"Close a Matter","deprecated":null,"version":null,"openapi":"/openapi/partner-api-v1.yaml post /v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}/lifecycle/close","href":"/api-reference/lifecycle/close-a-matter"},{"title":"Reopen a Matter closed by the current Source integration","deprecated":null,"version":null,"openapi":"/openapi/partner-api-v1.yaml post /v1/clients/{clientCode}/matters/by-client-reference/{clientReferenceId}/lifecycle/reopen","href":"/api-reference/lifecycle/reopen-a-matter-closed-by-the-current-source-integration"}]}]}]},"basePath":"","title":"Get a Matter by CasePath IQ ID - CasePath IQ API","buildId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","deploymentId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-bDkRQgq9.js","dist-CUljsAY7.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-B2t_mZQG.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-DPDWPCdE.js","utils-DyjUHyLo.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BWYE1cdS.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-COAzxpEw.js","snippetPresets-DNiD_S52.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-CjwVt80x.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ByHQMk7z.js","shallow-CaZuw1AO.js","getApiPlaygroundDisplay-DPVPOknm.js","CodeSnippet-B31CH-Mp.js","CodeSnippets-BxTYZWz6.js","Page-DDHbuAIY.js","getPastedJson-DhoAwiNO.js","icon-Dhq8z75J.js","MethodPill-DLXmKOwr.js","DuplicateIcon-jzdVwyRU.js","createIcon-eD0b3klN.js","DynamicMarkdown-BfddVCX7.js","SectionHeading-2pSCIo17.js","axios-vUo_bRtp.js","Markdown-DsWjhwJ4.js","AssistantPageLink-Cf70306N.js"]}