IncomeCertificationPayload
Payitoff API: IncomeCertificationPayload
Schema
The IncomeCertificationPayload
describes the request payload required when uploading a file to our API for a Borrower
's Income Certification, which is required when submitting IDR Enrollment Requests.
Use
IncomeCertificationPayload
for APIPOST
,PUT
, andPATCH
requestsWhen creating and updating a
Borrower
with supporting Income Certification document(s), you must use theIncomeCertificationPayload
object as your payload in the singularincome_certification
property of aBorrowerPayload
payload.When a
Borrower
is returned by the API, theBorrower
object will hold a pluralincome_certifications
property withIncomeCertification
object(s) within.
Schema Definition
Property | Type | Format | Description |
---|---|---|---|
file | string | byte | Base64-encoded file object to upload. |
type | string | pay_stub tax_return determination_summary | The type of supporting income/unemployment documentation uploaded for Enrollment or recertification. |
Example
"income_certification": {
"file": "iVBORw0KGgoAAAANSUhEUgAABHIAAAH6CAYAAABrkGv...",
"type": "tax_return"
}
Updated almost 3 years ago