Corgi BankDocumentation
OpenAPI

The Payable Recipient object

Reviewed external beneficiary, source context and signature trust for payable remittance.

Attributes

actorstringRequired
agencyobject or nullOptional

Agency holds the reviewed terms of an agency protocol; omitted for a beneficiary wire so the digests of recipients reviewed before agency protocols existed are unchanged.

4 child attributes
child_supportobject or nullOptional

ChildSupportTerms bind one served child support order to its state disbursement unit.

11 child attributes
application_idstringRequired
case_idstringRequired

Example case_2tVh8nqLxq4GbDe0K1F6S9zRcWm

disbursement_unitstringRequired
fipsstringOptional
medical_supportstringRequired
ncp_identifier_idstringRequired
ncp_identifier_last4stringRequired
ncp_namestringOptional
order_evidence_referencestringRequired
order_evidence_sha256stringRequired
statestringRequired
levyobject or nullOptional

LevyTerms bind one served Form 668-A notice.

4 child attributes
noticeobjectRequired

LevyNotice is what the bank copies from the served notice. The taxpayer's identifying number is held sealed by the caller; only its last four digits are part of this record.

9 child attributes
form_numberstringRequired
identifier_last4stringRequired
irs_office_contactstringRequired
notice_datestring · dateRequired

A business date, YYYY-MM-DD

periodsarray of objectsRequired
reply_toobjectRequired

Address is a mailing address.

served_datestring · dateRequired

A business date, YYYY-MM-DD

taxpayer_namestringRequired
total_due_minorintegerRequired
notice_evidence_referencestringRequired
notice_evidence_sha256stringRequired
taxpayer_identifier_idstringRequired
tax_depositobject or nullOptional

TaxDepositTerms bind the bank's EFTPS ACH credit enrollment for one return and tax year.

9 child attributes
deposit_schedulestringOptional
enrollment_evidence_referencestringRequired
enrollment_evidence_sha256stringRequired
formstringRequired
schedule_evidence_referencestringOptional
schedule_evidence_sha256stringOptional
tax_yearintegerRequired
taxpayer_einstringRequired
taxpayer_namestringRequired
unclaimed_propertyobject or nullOptional

UnclaimedPropertyTerms bind the bank's holder enrollment with one state administrator.

5 child attributes
enrollment_evidence_referencestringRequired
enrollment_evidence_sha256stringRequired
holderobjectRequired

NAUPAHolder is the HOLDER record.

16 child attributes
citystringRequired
claims_contactobject or nullOptional

NAUPAContact is a HOLDER-CONTACT group.

contactobjectRequired

NAUPAContact is a HOLDER-CONTACT group.

countystringRequired
faxstringOptional
incorporated_datestring · dateRequired

A business date, YYYY-MM-DD

incorporated_statestringOptional
naicsstringRequired
namestringRequired
report_numberintegerRequired
report_typestringRequired
report_yearintegerRequired
sicstringOptional
statestringRequired
tax_idstringRequired
tax_id_extstringRequired
portal_holder_idstringRequired
statestringRequired
authority_evidence_referencestringRequired
authority_evidence_sha256stringRequired
content_sha256stringRequired
created_atstring · date-timeRequired
decisionobject or nullOptional
5 child attributes
actorstringRequired
atstring · date-timeRequired
content_sha256stringRequired
decisionstringRequired
reasonstringRequired
destinationobjectRequired

Destination is the exact reviewed beneficiary and domestic receiving account. A valid routing checksum does not establish actual bank or account ownership.

3 child attributes
account_numberstringRequired
legal_namestringRequired
routing_numberstringRequired
environmentstringRequired
idstringRequired
jurisdictionstringRequired
key_idstringRequired
kindstringRequired
legal_entitystringRequired
loan_idstringOptional

Example loan_2tVh8nqLxq4GbDe0K1F6S9zRcWm

master_cash_external_account_referencestringRequired
payee_referencestringRequired
protocolstringRequired
providerstringRequired
public_keystringRequired
receiving_bank_namestringRequired
revocationobject or nullOptional
3 child attributes
actorstringRequired
atstring · date-timeRequired
reasonstringRequired
valid_fromstring · dateRequired

A business date, YYYY-MM-DD

valid_throughstring · dateRequired

A business date, YYYY-MM-DD

to move to open esc to close