> For the complete documentation index, see [llms.txt](https://selenium-4.gitbook.io/nexus-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://selenium-4.gitbook.io/nexus-docs/docs/document-services/initiate-document/main.md). # Initiate Document | Campo | Valor | | ------------------ | ----------------------------------------------- | | **Service Domain** | Document Services | | **BIAN Version** | 14.0.0 | | **Operation** | Initiate Document | | **Method** | POST | | **API Name** | Document Services API | | **Versão** | v1.0.0 | | **Endpoint** | `POST /v1/document-services/document-directory` | | **Autenticação** | Bearer Token (OAuth 2.0 / OIDC) | *** ## 1. Descrição da Operação A operação `InitiateDocument` cria um novo registo de documento no directório de documentos (Document Directory). Inclui: * A configuração do serviço documental (tipo de serviço, categoria, frequência de actualização e responsável pela manutenção); * Os detalhes do documento (tipo, subtipo, nome, descrição, formato, idioma, classificação e período de retenção); * A propriedade, a segurança, o conteúdo e os requisitos de conformidade regulatória do documento; * O estado inicial do fluxo de trabalho (workflow) e o contexto de negócio associado (ex: processo de abertura de conta). *** ## 2. Payload de Pedido (Request) ### 2.1 Exemplo ```json { "documentDirectoryInitiateInputRecord": { "documentDirectoryInitiateActionRequest": "InitiateDocument", "documentDirectoryInitiateActionTaskRecord": { "documentDirectoryInitiateActionRequest": "InitiateDocument", "documentDirectoryInitiateActionTaskReference": "DDIR-001", "documentDirectoryInstanceRecord": { "documentDirectoryInstanceReference": "DOC-DIR-001", "documentDirectoryConfiguration": { "documentServiceType": "DocumentManagement", "documentCategory": "CustomerDocuments", "documentUpdateFrequency": "Real-time", "documentMaintainerReference": "DOCUMENT-SVC-001" }, "documentDirectoryEntryRecord": { "documentEntryDetails": { "documentType": "IDENTIFICATION", "documentSubType": "PASSPORT", "documentName": "Customer Passport Document", "documentDescription": "Primary identification document for KYC verification", "documentFormat": "PDF", "documentMimeType": "application/pdf", "documentLanguage": "en-US", "documentClassification": "CONFIDENTIAL", "documentRetentionPeriod": "P10Y", "documentOwnership": { "documentOwnerReference": "CUST-001", "documentOwnerType": "CUSTOMER", "documentOwnerName": "John Doe" }, "documentSecurity": { "encryptionMethod": "AES-256", "accessLevel": "RESTRICTED", "accessPermissions": ["READ", "DOWNLOAD"], "digitalSignatureRequired": true }, "documentContent": { "documentData": "base64-encoded-document-content-here", "documentMetadata": { "originalFileName": "passport_john_doe.pdf", "documentSource": "CUSTOMER_UPLOAD", "uploadMethod": "WEB_PORTAL", "scanQuality": "HIGH", "documentPageCount": 32 } }, "documentCompliance": { "regulatoryRequirements": ["KYC", "AML", "GDPR"], "complianceChecksRequired": true, "privacyConsent": true, "retentionConsentGiven": true }, "documentWorkflow": { "initialWorkflowState": "SUBMITTED", "workflowOwner": "COMPLIANCE_TEAM", "processingPriority": "NORMAL", "expectedProcessingTime": "PT2H", "notificationRequired": true }, "businessContext": { "relatedAccountId": null, "relatedApplicationId": "APP-2025-001", "businessProcess": "ACCOUNT_OPENING", "documentPurpose": "IDENTITY_VERIFICATION", "externalReferences": { "applicationReference": "APP-2025-001", "caseReference": "CASE-KYC-001" } } } } } } } } ``` ### 2.2 Objecto: `documentDirectoryInitiateInputRecord` | Campo | Tipo | Descrição | | ------------------------------------------- | ------ | ----------------------------------------------------------------------- | | `documentDirectoryInitiateActionRequest` | string | Identificador da ação de negócio solicitada. Valor: `InitiateDocument`. | | `documentDirectoryInitiateActionTaskRecord` | object | Registo da tarefa de iniciação do documento. Ver secção 2.3. | ### 2.3 Objecto: `documentDirectoryInitiateActionTaskRecord` | Campo | Tipo | Descrição | | ---------------------------------------------- | ------ | -------------------------------------------------------------------------- | | `documentDirectoryInitiateActionRequest` | string | Identificador da ação de negócio solicitada (repetido ao nível da tarefa). | | `documentDirectoryInitiateActionTaskReference` | string | Referência única da tarefa de iniciação (ex: `DDIR-001`). | | `documentDirectoryInstanceRecord` | object | Registo da instância do directório de documentos. Ver secção 2.4. | ### 2.4 Objecto: `documentDirectoryInstanceRecord` | Campo | Tipo | Descrição | | ------------------------------------ | ------ | --------------------------------------------------------------------------------- | | `documentDirectoryInstanceReference` | string | Identificador único da instância do directório de documentos (ex: `DOC-DIR-001`). | | `documentDirectoryConfiguration` | object | Configuração do serviço documental. Ver secção 2.5. | | `documentDirectoryEntryRecord` | object | Registo da entrada do documento a criar. Ver secção 2.6. | ### 2.5 Objecto: `documentDirectoryConfiguration` | Campo | Tipo | Descrição | | ----------------------------- | ------ | ----------------------------------------------------------------------------------- | | `documentServiceType` | string | Tipo de serviço documental (ex: `DocumentManagement`). | | `documentCategory` | string | Categoria do documento (ex: `CustomerDocuments`). | | `documentUpdateFrequency` | string | Frequência de actualização do directório (ex: `Real-time`). | | `documentMaintainerReference` | string | Referência do sistema/serviço responsável pela manutenção (ex: `DOCUMENT-SVC-001`). | ### 2.6 Objecto: `documentDirectoryEntryRecord.documentEntryDetails` | Campo | Tipo | Descrição | | ------------------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `documentType` | string | Tipo do documento (ex: `IDENTIFICATION`). | | `documentSubType` | string | Subtipo do documento (ex: `PASSPORT`). | | `documentName` | string | Nome do documento. | | `documentDescription` | string | Descrição do documento. | | `documentFormat` | string | Formato do ficheiro (ex: `PDF`). | | `documentMimeType` | string | Tipo MIME do ficheiro (ex: `application/pdf`). | | `documentLanguage` | string | Idioma do documento (ex: `en-US`). | | `documentClassification` | string | Classificação de confidencialidade (ex: `CONFIDENTIAL`). | | `documentRetentionPeriod` | string (ISO 8601 duration) | Período de retenção do documento (ex: `P10Y` = 10 anos). | | `documentOwnership` | object | Dados do proprietário do documento (`documentOwnerReference`, `documentOwnerType`, `documentOwnerName`). | | `documentSecurity` | object | Requisitos de segurança do documento (`encryptionMethod`, `accessLevel`, `accessPermissions[]`, `digitalSignatureRequired`). | | `documentContent` | object | Conteúdo e metadados do ficheiro (`documentData` em base64, `documentMetadata` com `originalFileName`, `documentSource`, `uploadMethod`, `scanQuality`, `documentPageCount`). | | `documentCompliance` | object | Requisitos de conformidade regulatória (`regulatoryRequirements[]`, `complianceChecksRequired`, `privacyConsent`, `retentionConsentGiven`). | | `documentWorkflow` | object | Estado inicial do fluxo de trabalho (`initialWorkflowState`, `workflowOwner`, `processingPriority`, `expectedProcessingTime`, `notificationRequired`). | | `businessContext` | object | Contexto de negócio associado ao documento (`relatedAccountId`, `relatedApplicationId`, `businessProcess`, `documentPurpose`, `externalReferences`). | *** ## 3. Payload de Resposta (Response) ### 3.1 Exemplo ```json { "documentDirectoryInitiateOutputRecord": { "documentDirectoryInitiateActionTaskRecord": { "documentDirectoryInitiateActionRequest": "InitiateDocument", "documentDirectoryInitiateActionTaskReference": "DDIR-001", "documentDirectoryInitiateActionTaskRecord": { "documentDirectoryInstanceRecord": { "documentDirectoryInstanceReference": "DOC-DIR-001", "documentDirectoryInstanceStatus": "Active", "documentDirectoryConfiguration": { "documentServiceType": "DocumentManagement", "documentCategory": "CustomerDocuments", "documentUpdateFrequency": "Real-time", "documentMaintainerReference": "DOCUMENT-SVC-001" }, "documentDirectoryEntryRecord": { "documentEntryReference": "DOC-ID-001", "documentEntryDetails": { "documentId": "DOC-ID-001", "documentType": "IDENTIFICATION", "documentSubType": "PASSPORT", "documentName": "Customer Passport Document", "documentDescription": "Primary identification document for KYC verification", "documentStatus": "SUBMITTED", "documentFormat": "PDF", "documentSize": 2048576, "documentMimeType": "application/pdf", "documentVersion": "1.0", "documentLanguage": "en-US", "documentClassification": "CONFIDENTIAL", "documentRetentionPeriod": "P10Y", "documentCreationDate": "2025-07-10T14:30:00Z", "documentLastModifiedDate": "2025-07-10T14:30:00Z", "documentExpiryDate": null, "documentOwnership": { "documentOwnerReference": "CUST-001", "documentOwnerType": "CUSTOMER", "documentOwnerName": "John Doe" }, "documentLocation": { "documentStorageType": "CLOUD", "documentStorageLocation": "s3://bank-documents/temp/DOC-ID-001.pdf", "documentAccessUrl": "https://secure.bank.com/documents/DOC-ID-001", "documentUploadId": "UPLOAD-2025-001" }, "documentSecurity": { "encryptionStatus": "ENCRYPTED", "encryptionMethod": "AES-256", "accessLevel": "RESTRICTED", "accessPermissions": ["READ", "DOWNLOAD"], "digitalSignature": false, "checksumMD5": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6", "checksumSHA256": "z9y8x7w6v5u4t3s2r1q0p9o8n7m6l5k4j3i2h1g0f9e8d7c6b5a4" }, "documentCompliance": { "regulatoryRequirements": ["KYC", "AML", "GDPR"], "complianceStatus": "PENDING_REVIEW", "lastComplianceCheck": null, "nextComplianceReview": "2025-07-10T16:30:00Z", "retentionCompliance": "PENDING", "privacyCompliance": "PENDING" }, "documentWorkflow": { "currentWorkflowState": "SUBMITTED", "workflowHistory": [ { "state": "SUBMITTED", "timestamp": "2025-07-10T14:30:00Z", "actor": "CUSTOMER", "actorReference": "CUST-001", "comment": "Document uploaded by customer", "systemGenerated": false } ], "nextAction": "DOCUMENT_VALIDATION", "workflowOwner": "COMPLIANCE_TEAM", "estimatedCompletionTime": "2025-07-10T16:30:00Z" }, "businessContext": { "relatedAccountId": null, "relatedApplicationId": "APP-2025-001", "businessProcess": "ACCOUNT_OPENING", "documentPurpose": "IDENTITY_VERIFICATION" } } } } } }, "documentDirectoryInitiateActionResponse": { "documentDirectoryInitiateActionResponseCode": "Success", "documentDirectoryInitiateActionResponseMessage": "Document successfully created with ID: DOC-ID-001", "documentDirectoryInitiateActionResponseDetails": { "documentId": "DOC-ID-001", "uploadReference": "UPLOAD-2025-001", "processingEstimate": "PT2H", "nextSteps": ["DOCUMENT_VALIDATION", "COMPLIANCE_CHECK"], "notificationsSent": ["EMAIL_CONFIRMATION", "SMS_RECEIPT"] } } } } ``` ### 3.2 Objecto: `documentEntryDetails` (campos adicionais face ao pedido) | Campo | Tipo | Descrição | | -------------------------- | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `documentId` | string | Identificador único atribuído ao documento (ex: `DOC-ID-001`). | | `documentStatus` | string | Estado do documento após iniciação (ex: `SUBMITTED`). | | `documentSize` | integer | Tamanho do ficheiro em bytes. | | `documentVersion` | string | Versão do documento (ex: `1.0`). | | `documentCreationDate` | string (ISO 8601) | Data/hora de criação do documento. | | `documentLastModifiedDate` | string (ISO 8601) | Data/hora da última modificação. | | `documentExpiryDate` | string (ISO 8601) \| null | Data de expiração do documento, quando aplicável. | | `documentLocation` | object | Localização de armazenamento (`documentStorageType`, `documentStorageLocation`, `documentAccessUrl`, `documentUploadId`). | | `documentSecurity` | object | Estado de segurança do documento, incluindo `encryptionStatus`, `checksumMD5` e `checksumSHA256` (adicionais face ao pedido). | | `documentCompliance` | object | Estado de conformidade (`complianceStatus`, `lastComplianceCheck`, `nextComplianceReview`, `retentionCompliance`, `privacyCompliance`). | | `documentWorkflow` | object | Estado corrente do fluxo de trabalho (`currentWorkflowState`, `workflowHistory[]`, `nextAction`, `workflowOwner`, `estimatedCompletionTime`). | ### 3.3 Objecto: `documentDirectoryInitiateActionResponse` | Campo | Tipo | Descrição | | ------------------------------------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------ | | `documentDirectoryInitiateActionResponseCode` | string | Código do resultado da operação (ex: `Success`). | | `documentDirectoryInitiateActionResponseMessage` | string | Mensagem descritiva do resultado da operação. | | `documentDirectoryInitiateActionResponseDetails` | object | Detalhes adicionais do resultado: `documentId`, `uploadReference`, `processingEstimate`, `nextSteps[]`, `notificationsSent[]`. | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://selenium-4.gitbook.io/nexus-docs/docs/document-services/initiate-document/main.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.