IncomeCertification
Payitoff API: IncomeCertification
Schema
We currently support uploading only a single IncomeCertification
at a time. If multiple IncomeCertifications
are uploaded over subsequent requests, we will only use the most recent IncomeCertification
for Assessment operations and Borrower
responses.
We want to support a future use case where multiple IncomeCertifications
may be uploaded and a subset of those documents chosen by a Borrower
as the documentation to submit with their IDR Enrollment Request. To avoid changes to the API in the future, this is why a Borrower
response provides the income_certifications
property as an array.
Use
IncomeCertificationPayload
for APIPOST
,PUT
, andPATCH
requestsWhen creating and updating a
Borrower
with supporting Income Certification document(s), you must use anIncomeCertificationPayload
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
(s) within.
Schema Definition
Property | Type | Format | Description |
---|---|---|---|
|
|
| The ID value of the |
|
|
| A |
|
|
| The type of supporting income/unemployment documentation uploaded for Enrollment or recertification. |
Example
{
"id": 198,
"inserted_at": "2021-02-18 21:33:29",
"type": "tax_return"
}
Updated 5 months ago