Required document logic
Every lending or financing request depends on a complete package of supporting paperwork:
- Identification.
- Income proof.
- Consents.
- Signed agreements.
A single missing document delays the decision or breaks a compliance rule. Creatio assembles the package for you:
- It derives the document list from the selected product and its conditions.
- It tracks whether each file has arrived.
- It holds the request at its current stage until the package is complete.
- It reuses documents the customer has already provided.
This article explains the logic behind that behavior across applications, application forms, and commercial opportunities. It is intended for business analysts, solution architects, and system administrators.
Required document purpose
Required documents ensure that every request has the correct set of supporting files at the correct stage. They enforce compliance rules, prevent missing paperwork, and adapt to the conditions of the selected product. Creatio works with the following document categories:
- Identity documents — the customer's official identification, collected on the application form.
- Required documents — supporting documents the customer must provide. Creatio generates them from the setup and conditions of the selected product.
- Documents for signing — documents the customer must formally sign. Creatio generates them from the setup and conditions of the selected product.
All categories share the same object model and the same business logic in applications, application forms, and opportunities.
Object model
Required document logic relies on the following connected objects:
- "Document" (
Documentcode). Stores the file and its metadata: class, group, type, status, and template. - "Required documents in application" (
DocListInFinAppcode). A connector object that links a document record to a specific application, application form, or opportunity.
When Creatio generates a document, it creates a "Required documents in application" (DocListInFinApp code) object record with the "Not uploaded" status and a "Document" (Document code) object record with the "Draft" status. The record keeps the "Not uploaded" status until someone attaches a file. Every context uses the same connector and the same "Document" (Document code) object. Only the process that triggers the generation differs.
Generation flow
Identity documents
Creatio collects identity documents on the application form and never generates them automatically. The "Create document from application form" business process runs when the user clicks 
in the Identity documents expanded list and selects the target document class. Creatio then verifies that the application does not already contain a document of this class, creates a "Required documents in application" (DocListInFinApp code) object record with a linked "Document" (Document code) object record, and opens the document mini page so that the user can enter the details. The user must upload a file before saving. If the user closes the mini page without saving, Creatio deletes the new records. After the user saves the document, Creatio copies the values of the document properties to the application form, provided that the related properties exist and contain values.
Required documents
The process that generates required documents depends on where the documents originate.
Documents originating from the application
Automatic generation runs through the "Generate required documents for application" business process that starts when the user clicks Generate in the Required documents list or tries to submit the application to the next stage. Creatio cannot start this process on stage entry, because the user must first select a product and fill out the product parameters. During generation, Creatio deletes the empty drafts left by the previous run and builds a new list of required documents from the selected product and its conditions.
Manual creation runs through the "Create required document from application" business process that starts when the user clicks in the Required documents list. Creatio opens a mini page where the user selects a document class and offers only the classes that meet all of the following conditions:
- The class is not yet added to the current application, application form, or opportunity.
- The class has the "Type" column set to "Customer document" and its "Group" column contains neither "Identification" nor "Legal entity identification." Alternatively, the class has the "Type" column set to "Compliance document" and the "Group" column set to "Consumer consent."
- The client type of the class matches the client type of the customer, individual or legal entity, or the class has no client type specified.
Documents originating from the application form
Creatio generates required documents on the application form through the "Create required document from application form" business process.
Documents originating from the opportunity
Automatic generation runs through the "Generate required documents for opportunity" business process. The "Launch required document generation for opportunity" business process starts it when the user selects a product on the opportunity. Manual creation runs through the "Create required document from opportunity" business process and applies the same document class conditions as the application.
Documents for signing
On the application, the "Generate required documents for application" business process generates the documents for signing as part of the "Process Agreement & Signature stage" business process when the application moves to this stage.
On the opportunity, Creatio does not generate documents for signing. The list shows the signing documents that Creatio generated in the linked application.
Upload logic
The "Update document status on attachment upload" business process keeps document statuses in sync with the attached files, and works the same way in every context. It runs when a user uploads a file to a document record or deletes a file from it. Creatio checks whether the connected document has any files. If one or more files exists, Creatio sets the status to "Active" for both the "Document" (Document code) object record and the "Required documents in application" (DocListInFinApp code) object record. If no files exist, Creatio sets the status to "Draft" for the "Document" (Document code) object record and to "Not uploaded" for the "Required documents in application" (DocListInFinApp code) object record.
Validation logic
On application stage change
The "Change application stage" business process holds an application at its current stage until the documentation is complete:
- Identity documents — the application must have one or more identity documents with the "Active" status.
- Required documents — every document that has the Required checkbox selected must have the "Active" status.
- Documents for signing — every document that has the Required checkbox selected must have the "Active" status.
If validation fails, the application stays at the current stage and Creatio shows the RequiredDocumentsNotValid or RequiredSignatureDocumentsNotValid window.
On opportunity stage change
The "Submit opportunity for underwriting" business process prevents the user from submitting an opportunity to underwriting until every document that has the Required checkbox selected reaches the "Active" status. Otherwise, Creatio shows the Opportunity_Validation_RequiredDocumentsNotValid_Dialog window.
On application form submission
Creatio validates the required documents on the application form when the user submits the form. The "Submit application form" business process runs this validation before it starts the KYC (know your customer) and KYB (know your business) evaluation.
On required document deletion
"Launch manual required document deletion" and "Delete required document and linked document" business processes handle deletion the same way in every context. They run when the user tries to delete a required document record from the list. Creatio checks whether other records use this document. If they do, Creatio blocks the deletion. If they do not, Creatio deletes both the "Required documents in application" (DocListInFinApp code) object record and the linked "Document" (Document code) object record.
Reuse logic
Customers often provide the same document for multiple requests, such as a passport or a proof of address. Creatio recognizes these documents and links them automatically, so the customer does not submit the same file twice.
The "Create document from required document" business process runs the same way in every context whenever Creatio adds a "Required documents in application" (DocListInFinApp code) object record. Creatio reads the document class of the record. If the class has the Reusable for new applications checkbox selected in the Document classes lookup, Creatio looks for a document of the same class with the "Active" status for the same contact. If Creatio finds a match, it links the existing document to the "Required documents in application" (DocListInFinApp code) object record through the Document field and sets the status to "Active." If Creatio finds no match or the class is not reusable, Creatio adds a new "Document" (Document code) object record with the "Draft" status and links it to the "Required documents in application" record.
You can make a document class reusable in the Document classes lookup. Learn more: Configure required documents for a product.