Borrower Get
Retrieves borrower detail data for a specific process. This endpoint retrieves detailed information for a borrower associated with a mortgage process. It validates that the process exists for the current broker and that the specified borrower belongs to the process. If either validation fails, a corresponding validation error is returned. The response data is localized using the language configured in the current request context.
path Parameters
processUniqueIdUnique identifier of the mortgage process.
borrowerUniqueIdUnique identifier of the borrower within the process.
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Borrower Get › Responses
The borrower details were successfully retrieved.
borrowerUniqueIDUnique identifier for the borrower
borrowerTypeIDType identifier for the borrower (e.g., KeyBorrower, Borrower)
borrowerTypeDescriptionDescription of the borrower type
keyBorrowerRelationIDRelation identifier to the key borrower (if applicable)
keyBorrowerRelationDescriptionDescription of the relation to the key borrower (if applicable)
Borrower Update
Updates an existing borrower for a process. This endpoint updates borrower information within a mortgage process. The request payload is mapped and validated against the process, borrower, and broker context. If validation passes, the borrower data is updated and the operation is attributed to the current user.
path Parameters
processUniqueIdUnique identifier of the mortgage process.
borrowerUniqueIdUnique identifier of the borrower to update.
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Borrower Update › Request Body
borrowerTypeIdType identifier for the borrower (e.g., KeyBorrower, borrower)
keyBorrowerRelationIdRelation identifier to the key borrower (optional)
Borrower Update › Responses
The borrower was successfully updated.
Borrower Delete
Deletes a borrower from a process. Does not delete KeyBorrower. This endpoint removes a borrower from the specified mortgage process, excluding key borrowers which cannot be deleted. Validation ensures the borrower exists, belongs to the process, and is eligible for deletion before the operation is executed.
path Parameters
processUniqueIdUnique identifier of the mortgage process.
borrowerUniqueIdUnique identifier of the borrower to delete.
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Borrower Delete › Responses
The borrower was successfully deleted.
Borrower List
Retrieves all borrowers associated with a process. This endpoint returns a list of all borrowers linked to the specified mortgage process. It validates that the process exists and is accessible to the current broker before retrieving borrower data. The response is localized based on the language defined in the request context.
path Parameters
processUniqueIdUnique identifier of the mortgage process.
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Borrower List › Responses
The list of borrowers was successfully retrieved.
Borrower Create
Creates a new borrower for a process. This endpoint creates a new borrower associated with the specified mortgage process. The request payload is mapped to a service-level model and validated against the process and broker context. If validation succeeds, the borrower is created and associated with the current user for auditing purposes.
path Parameters
processUniqueIdUnique identifier of the mortgage process.
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Borrower Create › Request Body
borrowerTypeIdType identifier for the borrower (e.g., KeyBorrower, borrower)
keyBorrowerRelationIdRelation identifier to the key borrower (optional)
Borrower Create › Responses
The borrower was successfully created.