Skip to main content

Lock applicant form

POST 
/rental-files/:applicant_id/lock-form/

This will change the form_submitted field for this applicant.

By triggering this, the applicant will not be able to change his form and this will trigger the next step of the Applicant's lifecycle (1)

(1)

  • if no analysis has been asked the applicant will move to COLLECTED state
  • if analysis has been asked the applicant will be analyzed.

🔒 Authentication​

This endpoint require a valid OAuth2 Bearer

It supports account impersonation within Organization's sub-accounts using X-Eaz-Account-Id Header.

  • If the X-Eaz-Account-Id header is provided and the user has access rights to that sub-account, the impersonation context is applied.
  • Otherwise, the user's own account context is used.

Scopes :​

User must provide one of the following scopes:

  • admin
  • staff
  • user
  • org:admin
  • org:staff
  • org:user
  • rental_file:write

Request​

Responses​

Successful Response