Configure income entity

This API allows you to update the employment start date for a borrower–employer pair linked to a specific Ocrolus Book. You can optionally include identifiers such as the employer’s EIN (Employer Identification Number) and the borrower’s last four SSN digits (Social Security Number) for more accurate matching. If the borrower–employer pair exists, the record is updated; otherwise, a new one is created. When provided, the employment start date is also used in income calculation to ensure the precise and consistent results across the platform.

📘

Note

  • If the borrower–employer pair already exists, the system updates the existing record with the new start date.
  • If the pair does not exist, a new configuration entry is created automatically.
  • Optional identifiers (ein, last_four_ssn_digits, and income_type) help ensure accurate borrower–employer matching.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique identifier of the Ocrolus Book for which borrower–employer data should be configured.

Body Params
entity_details
object
required

Details about the employer entity.

borrower_details
object
required

Details about the borrower.

string

A unique identifier for the borrower/employer pair. If you are using xid to match or update an existing income record, it is recommended to also provide the corresponding income_type. If income_type is not included, the system may not match the existing record.

date

Employment start date in the YYYY-MM-DD format.

string
enum

Type of income of the borrower.

👍

Tip

Providing income_type along with xid is recommended for accurate matching of existing records. If income_type is not provided, the system may not recognize the existing record.

Allowed:
Responses

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