Payitoff

Payitoff Documentation

Explore our guides, examples, and documentation to integrate Payitoff into your products.

We'll get you up and running in an afternoon - or we owe you a beer / mocktail!

Get Started    API Reference

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 API POST, PUT, and PATCH requests

When creating and updating a Borrower with supporting Income Certification document(s), you must use the IncomeCertificationPayload object as your payload in the singular income_certification property of a BorrowerPayload payload.

When a Borrower is returned by the API, the Borrower object will hold a plural income_certifications property with IncomeCertification 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 7 months ago


IncomeCertificationPayload


Payitoff API: IncomeCertificationPayload Schema

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.