Downloads the income ZIP generated by Generate income ZIP for a Book. The ZIP contains the income calculation PDF and, depending on the settings used to generate it, the borrower's source documents and income comments.

Pass the same guideline, source_documents, and comments values that you used to generate the ZIP. Each combination of settings identifies a separate ZIP. The response type depends on the generation state: application/zip when the ZIP is ready, otherwise application/json.

📘

Note

• If the ZIP is still being generated, this endpoint returns 202 Accepted with zip_status: PROCESSING. Wait a few seconds and call it again until it returns 200 OK with the ZIP file.
• If no ZIP has been generated for these settings, call Generate income ZIP first.
• A generated ZIP stays available for 30 days. After that, you must generate it again.
• The 200 OK response is the ZIP file itself, not a JSON object.

Standard flow

1. Call Generate income ZIP with your settings.
2. Call this endpoint with the same settings. If it returns 202 Accepted, wait a few seconds and call it again.
3. When it returns 200 OK, save the response body as a .zip file.