Create an unclaimed property report

POST/unclaimed-property-reports

Fresh verified staff with payments:operations:write authority is required. Propose a NAUPA standard electronic holder report from registered escheat obligations for an approved unclaimed property recipient. Owner tax identifiers are named by sealed identifier records, never carried in the request. Customer authority is refused. Requests are strict single JSON objects bounded to 8 MiB; complete responses are bounded to 16 MiB and never silently truncated.

Headers

Idempotency-KeystringRequired

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

propertiesarray of objectsRequired

16 child attributes

account_numberstringOptional

addition_minorintegerRequired

addition_typestringOptional

additional_ownersarray of objectsOptional

19 child attributes

address1stringOptional

address2stringOptional

address3stringOptional

business_namebooleanOptional

citystringOptional

countrystringOptional

countystringOptional

date_of_birthstring · dateRequired

A business date, YYYY-MM-DD

first_namestringOptional

last_namestringRequired

middle_namestringOptional

owner_type_codestringRequired

prefixstringOptional

relationship_codestringRequired

statestringOptional

suffixstringOptional

tax_id_extstringOptional

titlestringOptional

zipstringOptional

check_numberstringOptional

deduction_minorintegerRequired

deduction_typestringOptional

descriptionstringOptional

interest_bearingbooleanRequired

interest_rateintegerRequired

last_transactionstring · dateRequired

A business date, YYYY-MM-DD

obligation_idstringRequired

ownerobjectRequired

NAUPAOwner is a PROPADD additional owner.

19 child attributes

address1stringOptional

address2stringOptional

address3stringOptional

business_namebooleanOptional

citystringOptional

countrystringOptional

countystringOptional

date_of_birthstring · dateRequired

A business date, YYYY-MM-DD

first_namestringOptional

last_namestringRequired

middle_namestringOptional

owner_type_codestringRequired

prefixstringOptional

relationship_codestringRequired

statestringOptional

suffixstringOptional

tax_id_extstringOptional

titlestringOptional

zipstringOptional

owner_identifier_idstringOptional

property_typestringRequired

reported_minorintegerRequired

recipient_idstringRequired

report_numberintegerRequired

report_typestringRequired

report_yearintegerRequired

Returns

200 OK

The Unclaimed Property Report object.

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

Request

curl -X POST 'https://api.dev.bank.corgi.com/unclaimed-property-reports' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "properties": [
      {
        "account_number": "string",
        "addition_minor": 0,
        "addition_type": "string",
        "additional_owners": [
          {
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "business_name": false,
            "city": "string",
            "country": "string",
            "county": "string",
            "date_of_birth": "2026-09-17",
            "first_name": "string",
            "last_name": "string",
            "middle_name": "string",
            "owner_type_code": "string",
            "prefix": "string",
            "relationship_code": "string",
            "state": "string",
            "suffix": "string",
            "tax_id_ext": "string",
            "title": "string",
            "zip": "string"
          }
        ],
        "check_number": "string",
        "deduction_minor": 0,
        "deduction_type": "string",
        "description": "string",
        "interest_bearing": false,
        "interest_rate": 0,
        "last_transaction": "2026-09-17",
        "obligation_id": "string",
        "owner": {
          "address1": "string",
          "address2": "string",
          "address3": "string",
          "business_name": false,
          "city": "string",
          "country": "string",
          "county": "string",
          "date_of_birth": "2026-09-17",
          "first_name": "string",
          "last_name": "string",
          "middle_name": "string",
          "owner_type_code": "string",
          "prefix": "string",
          "relationship_code": "string",
          "state": "string",
          "suffix": "string",
          "tax_id_ext": "string",
          "title": "string",
          "zip": "string"
        },
        "owner_identifier_id": "string",
        "property_type": "string",
        "reported_minor": 0
      }
    ],
    "recipient_id": "string",
    "report_number": 0,
    "report_type": "string",
    "report_year": 0
  }'

Response200

{
  "acknowledgments": [
    {
      "document": {
        "agency": "string",
        "agency_reference": "string",
        "amount_minor": 0,
        "content_sha256": "string",
        "environment": "string",
        "event_id": "string",
        "fields": {},
        "key_id": "string",
        "kind": "string",
        "occurred_at": "2026-09-17T14:30:00Z",
        "reasons": [],
        "signature": "string",
        "submission_reference": "string",
        "version": "string"
      },
      "id": "string",
      "recorded_at": "2026-09-17T14:30:00Z",
      "recorded_by": "string",
      "submission_id": "string"
    }
  ],
  "actor": "string",
  "content_sha256": "string",
  "created_at": "2026-09-17T14:30:00Z",
  "decision": {
    "actor": "string",
    "at": "2026-09-17T14:30:00Z",
    "content_sha256": "string",
    "decision": "string",
    "reason": "string"
  },
  "id": "string",
  "obligations": [
    {
      "account_id": "acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "amount_minor": 0,
      "content_sha256": "string",
      "created_at": "2026-09-17T14:30:00Z",
      "currency": "USD",
      "customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "evidence_reference": "string",
      "hold_id": "hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "id": "string",
      "issuer": "string",
      "jurisdiction": "string",
      "kind": "string",
      "legal_entity": "string",
      "loan_id": "loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "payee_reference": "string",
      "source": {
        "closure_component": "string",
        "closure_ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
        "journal_id": "jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
        "journal_key": "string",
        "journal_sha256": "string",
        "ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm"
      },
      "source_date": "2026-09-17",
      "source_date_basis": "string",
      "source_id": "string",
      "source_sha256": "string",
      "tax_customer_id": "cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
      "tax_period": "string"
    }
  ],
  "remittance_reference": "string",
  "remitted_minor": 0,
  "report_sha256": "string",
  "request": {
    "properties": [
      {
        "account_number": "string",
        "addition_minor": 0,
        "addition_type": "string",
        "additional_owners": [],
        "check_number": "string",
        "deduction_minor": 0,
        "deduction_type": "string",
        "description": "string",
        "interest_bearing": false,
        "interest_rate": 0,
        "last_transaction": "2026-09-17",
        "obligation_id": "string",
        "owner": {},
        "owner_identifier_id": "string",
        "property_type": "string",
        "reported_minor": 0
      }
    ],
    "recipient_id": "string",
    "report_number": 0,
    "report_type": "string",
    "report_year": 0
  },
  "schedule": {
    "as_of": "2026-09-17",
    "citations": [
      "string"
    ],
    "holder_class": "string",
    "remit_from": "2026-09-17",
    "remit_through": "2026-09-17",
    "report_due": "2026-09-17",
    "report_with_payment": false,
    "report_year": 0,
    "state": "string",
    "two_phase": false,
    "weekend_adjustments": "string"
  },
  "state": "string",
  "submission": {
    "actor": "string",
    "adapter": "string",
    "agency": "string",
    "attributes": {},
    "content_sha256": "string",
    "created_at": "2026-09-17T14:30:00Z",
    "id": "string",
    "kind": "string",
    "receipt": {
      "agency": "string",
      "content_sha256": "string",
      "environment": "string",
      "kind": "string",
      "received_at": "2026-09-17T14:30:00Z",
      "reference": "string"
    },
    "subject_id": "string",
    "subject_kind": "string"
  },
  "summary": {
    "addition_minor": 0,
    "advertised_minor": 0,
    "creator": "string",
    "creator_contact": "string",
    "deduction_minor": 0,
    "deletion_minor": 0,
    "negative": false,
    "properties": 0,
    "records": 0,
    "remitted_minor": 0,
    "reported_minor": 0,
    "software_version": "string"
  }
}