Generate income ZIP

Starts generating the income ZIP for a Book. Generation is asynchronous. Each combination of guideline, source_documents, and comments is its own archive. Call this endpoint first, then poll Download income ZIP until it returns 200.

Response scenarios

Statuszip_statusWhen
202PROCESSINGNo archive exists yet, the previous archive expired or failed, or a job is already running. Header: Retry-After: 30.
200COMPLETEDAn archive for the same options already exists. No new job is queued.

On this endpoint, zip_status is PROCESSING or COMPLETED. If the previous archive expired or failed, the request starts a new generation and returns 202.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

UUID of the Book to generate the income ZIP for.

Query Params
string
enum
Defaults to FANNIE_MAE

Loan guideline to apply. Defaults to FANNIE_MAE. An invalid value returns 400.

Allowed:
boolean
Defaults to false

When true, merges the source documents into the PDF. Defaults to false.

boolean
Defaults to true

When true, includes the comments recorded on the income calculation in the ZIP.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Choose an example:
application/json