v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB

Income

Save income guideline

This API lets you set or update the loan program or Government-Sponsored Enterprise (GSE) guideline for an Ocrolus <glossary:Book>. It ensures income calculations use the correct guideline (for example, Fannie Mae, Freddie Mac, FHA, VA, or USDA) and that the results are accurately reflected in the Ocrolus Dashboard for underwriting review. The most recent guideline is always used for income calculations by default.

You can use this API to:

Set the income guideline immediately after the Book is created.
Update the income guideline with a different guideline value later if the loan program changes.

📘 Notes

A valid book_uuid is required.

Updated income calculations are reflected after processing is complete.

put/v2/book/{book_uuid}/income-guideline

Path parameters

book_uuidstring uuid required

The unique identifier of the Ocrolus <glossary:Book> for which the loan program or GSE guideline should be created or updated.

Query parameters

Example:FANNIE_MAE

The guideline to be used for retrieving the income calculations. Supported values include FANNIE_MAE, FREDDIE_MAC, FHA, VA, USDA, CONVENTIONAL`.

📘 The CONVENTIONAL guideline translates to the Fannie Mae income guideline.

Response

Success

Example response

{
  "response": {
    "book_uuid": "13e6d579-4699-43e2-a419-8a29bcb5f922",
    "income_guideline": "FANNIE_MAE",
    "staus": "created"
  }
}