Document Get
Retrieves a specific document for a process. This endpoint retrieves detailed information for a document associated with a mortgage process. It validates that the process exists for the current broker and that the specified document belongs to the process before retrieving the document data.
path Parameters
processUniqueIdUnique identifier of the mortgage process.
documentUniqueIdUnique identifier of the document to retrieve.
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Document Get › Responses
The document details were successfully retrieved.
fileNameStored file name of the document
titleDocument title or brief description
contentDocument content (base64)
Document Update
Updates an existing document for a process. This endpoint updates document metadata or content associated with a mortgage process. The request payload is mapped and validated against the process, document, and broker context before the update is persisted.
path Parameters
processUniqueIdUnique identifier of the mortgage process.
documentUniqueIdUnique identifier of the document to update.
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Document Update › Request Body
documentTitleDocument title or brief description (optional)
documentTypeIDIdentifier of the document type (optional)
fileNameStored file name for the document (optional)
documentObservationsAdditional observations or notes about the document (optional)
documentContentDocument content (base64-encoded string) (optional)
Document Update › Responses
The document was successfully updated.
Document Delete
Deletes a document from a process. This endpoint deletes a document associated with the specified mortgage process. It validates that the process and document exist and belong to the current broker before performing the deletion.
path Parameters
processUniqueIdUnique identifier of the mortgage process.
documentUniqueIdUnique identifier of the document to delete.
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Document Delete › Responses
The document was successfully deleted.
Document List
Retrieves all documents associated with a process. This endpoint returns a list of all documents linked to the specified mortgage process. It validates that the process exists and is accessible to the current broker before retrieving document 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}
Document List › Responses
The list of documents was successfully retrieved.
Document Create
Creates a new document for a process. This endpoint creates a new document associated with the specified mortgage process. The request payload is mapped to a service-level model and validated against the process and broker context. Upon successful validation, the document is created and attributed to the current user.
path Parameters
processUniqueIdUnique identifier of the mortgage process.
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Document Create › Request Body
documentTitleDocument title or brief description
documentTypeIDIdentifier of the document type
fileNameStored file name for the document
rejectedFileIndicator or reason used when a file is rejected (required)
documentContentDocument content (base64-encoded string)
documentObservationsAdditional observations or notes about the document (optional)
Document Create › Responses
The document was successfully created.