Skip to main content
PATCH
/
cases
/
{case_id}
/
unclaimed-property
/
{property_id}
Update unclaimed property
curl --request PATCH \
  --url https://api.example.com/v1/cases/{case_id}/unclaimed-property/{property_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "state": "<string>",
  "holder_name": "<string>",
  "reported_amount": 123,
  "property_description": "<string>",
  "owner_name_on_record": "<string>",
  "claim_url": "<string>",
  "required_documents": [],
  "document_ids": [
    "<string>"
  ],
  "notes": "<string>"
}
'
{
  "data": {
    "id": "01K9UP01AJ0T66HRYE78AN7UUU",
    "case_id": "<string>",
    "property_type": "dormant_bank_account",
    "holder_name": "State of Illinois",
    "state": "IL",
    "reported_amount": 1250,
    "property_description": "Dormant checking account",
    "owner_name_on_record": "JANE M DOE",
    "claim_status": "discovered",
    "claim_url": "<string>",
    "claim_filed_date": "2023-12-25",
    "claim_approved_date": "2023-12-25",
    "claim_paid_amount": 123,
    "required_documents": [],
    "document_ids": [
      "<string>"
    ],
    "notes": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
case_id
string
required

Unique case identifier (ULID format).

​
property_id
string
required

Body

application/json
​
property_type
enum<string>
required
Available options:
dormant_bank_account,
uncashed_check,
insurance_proceeds,
utility_deposit,
rental_deposit,
safe_deposit_box,
stocks_bonds,
retirement_account,
gift_card,
insurance_refund,
mineral_rights,
wages,
refund,
other
​
state
string
required
Required string length: 2
​
holder_name
string
​
reported_amount
number<double>
​
property_description
string
​
owner_name_on_record
string
​
claim_url
string
​
claim_status
enum<string>
Available options:
discovered,
claim_filed,
under_review,
approved,
paid,
denied,
expired
​
required_documents
enum<string>[]
Available options:
death_certificate,
letters_testamentary,
letters_of_administration,
affidavit,
government_id,
proof_of_heirship
​
document_ids
string[]
​
notes
string

Response

Record updated.

​
data
object