Corgi BankDocumentation
OpenAPI

The Unclaimed Property Report object

UnclaimedPropertyReport is a proposed holder report, its review, submission and acknowledgments.

Attributes

acknowledgmentsarray of objectsOptional
5 child attributes
documentobjectRequired

Acknowledgment is one signed agency outcome for a submission.

14 child attributes
agencystringRequired
agency_referencestringOptional
amount_minorintegerRequired
content_sha256stringRequired
environmentstringRequired
event_idstringRequired
fieldsobjectOptional
key_idstringRequired
kindstringRequired
occurred_atstring · date-timeRequired
reasonsarray of stringsOptional
signaturestringRequired
submission_referencestringRequired
versionstringRequired
idstringRequired
recorded_atstring · date-timeRequired
recorded_bystringRequired
submission_idstringRequired
actorstringRequired
content_sha256stringRequired
created_atstring · date-timeRequired
decisionobject or nullOptional
5 child attributes
actorstringRequired
atstring · date-timeRequired
content_sha256stringRequired
decisionstringRequired
reasonstringRequired
idstringRequired
obligationsarray of objectsRequired
22 child attributes
account_idstringOptional

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amount_minorintegerRequired
content_sha256stringRequired
created_atstring · date-timeRequired
currencystringRequired
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

evidence_referencestringRequired
hold_idstringRequired

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

idstringRequired
issuerstringRequired
jurisdictionstringOptional
kindstringRequired
legal_entitystringRequired
loan_idstringOptional

Example loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm

payee_referencestringOptional
sourceobjectRequired
6 child attributes
closure_componentstringOptional
closure_ledger_account_idstringOptional

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

journal_keystringRequired
journal_sha256stringRequired
ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

source_datestring · dateRequired

A business date, YYYY-MM-DD

source_date_basisstringOptional
source_idstringRequired
source_sha256stringRequired
tax_customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

tax_periodstringOptional
remittance_referencestringOptional
remitted_minorintegerRequired
report_sha256stringRequired
requestobjectRequired

UnclaimedPropertyReportRequest proposes one holder report for an approved unclaimed property recipient.

5 child attributes
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
scheduleobjectRequired

HolderReportSchedule is when a state wants a bank's unclaimed property report and remittance for a report year. RemitFrom is zero where the cited source gives no earliest date.

11 child attributes
as_ofstring · dateRequired

A business date, YYYY-MM-DD

citationsarray of stringsRequired
holder_classstringRequired
remit_fromstring · dateRequired

A business date, YYYY-MM-DD

remit_throughstring · dateRequired

A business date, YYYY-MM-DD

report_duestring · dateRequired

A business date, YYYY-MM-DD

report_with_paymentbooleanRequired
report_yearintegerRequired
statestringRequired
two_phasebooleanRequired
weekend_adjustmentsstringRequired
statestringRequired
submissionobject or nullOptional

AgencySubmission is one hand-off to the agency adapter and, once the carrier answered, its receipt. A receipt is not an agency decision.

11 child attributes
actorstringRequired
adapterstringRequired
agencystringRequired
attributesobjectRequired
content_sha256stringRequired
created_atstring · date-timeRequired
idstringRequired
kindstringRequired
receiptobject or nullOptional

SubmissionReceipt is the carrier's answer that it holds the submission. It is not an agency decision.

6 child attributes
agencystringRequired
content_sha256stringRequired
environmentstringRequired
kindstringRequired
received_atstring · date-timeRequired
referencestringRequired
subject_idstringRequired
subject_kindstringRequired
summaryobjectRequired

NAUPASummary is the SUMINFO record.

12 child attributes
addition_minorintegerRequired
advertised_minorintegerRequired
creatorstringRequired
creator_contactstringRequired
deduction_minorintegerRequired
deletion_minorintegerRequired
negativebooleanRequired
propertiesintegerRequired
recordsintegerRequired
remitted_minorintegerRequired
reported_minorintegerRequired
software_versionstringRequired

to move to open esc to close