Process ESIS Get
Retrieves the ESIS document for a process. This endpoint generates and retrieves the ESIS for the specified mortgage process using the current iteration associated with the process. The generation can optionally ignore validation rules to comply with Law 24/2023 requirements. If ESIS generation fails, a validation error is returned. (Currently only portuguese works.)
path Parameters
processUniqueIdUnique identifier of the mortgage process.
query Parameters
ignoreRulesIndicates whether ESIS generation rules (Law 24/2023) should be ignored.
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Process ESIS Get › Responses
The ESIS document was successfully generated.
esisESIS file in Base64 string format
Process ESIS Email
Sends the ESIS document for a process by email. This endpoint generates the ESIS for the specified mortgage process and sends it to the provided email address. ESIS generation is performed using the current process iteration and may optionally ignore validation rules. If ESIS generation or email delivery fails, a validation error is returned. (Currently only portuguese works)
path Parameters
processUniqueIdUnique identifier of the mortgage process.
query Parameters
ignoreRulesIndicates whether ESIS generation rules (Law 24/2023) should be ignored.
sendAddressEmail address to which the ESIS will be sent.
Headers
AuthorizationBearer token for authentication. Format: Bearer {token}
Process ESIS Email › Responses
The ESIS was successfully sent by email.