--- agentTools: projectIndex: https://docs.grafeno.digital/llms.txt --- # Consulta de Documentos por ID Consulta os documentos da organização por ID. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Signer", "version": "3.0.0" }, "servers": [ { "url": "https://signer.dev.grafeno.be/" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "x-api-key" } } }, "security": [ { "sec0": [] } ], "paths": { "/api/documents/{id}": { "get": { "summary": "Consulta de Documentos por ID", "description": "Consulta os documentos da organização por ID.", "operationId": "consulta-de-documentos-por-id", "parameters": [ { "name": "id", "in": "path", "description": "Id do documento.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"checksumMd5\": \"string\",\n \"isDeleted\": true,\n \"flowActions\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"creationDate\": \"2024-07-29T13:38:34.829Z\",\n \"pendingDate\": \"2024-07-29T13:38:34.829Z\",\n \"updateDate\": \"2024-07-29T13:38:34.829Z\",\n \"user\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"email\": \"user@example.com\",\n \"phone\": \"string\"\n },\n \"numberRequiredSignatures\": 0,\n \"signRuleUsers\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"email\": \"string\",\n \"phone\": \"string\",\n \"signatureDate\": \"2024-07-29T13:38:34.829Z\",\n \"isElectronic\": true,\n \"refusalDate\": \"2024-07-29T13:38:34.829Z\",\n \"hasRefused\": true,\n \"refusalReason\": \"string\"\n }\n ],\n \"marks\": [\n {\n \"topLeftX\": 0,\n \"topLeftY\": 0,\n \"width\": 0,\n \"height\": 0,\n \"pageNumber\": 0,\n \"type\": \"SignatureVisualRepresentation\"\n }\n ],\n \"allowElectronicSignature\": true,\n \"requireEmailAuthenticationToSignElectronically\": true,\n \"requireSmsAuthenticationToSignElectronically\": true,\n \"requireWhatsappAuthenticationToSignElectronically\": true,\n \"requireAuthenticatorAppToSignElectronically\": true,\n \"requireSelfieAuthenticationToSignElectronically\": true,\n \"requireDatavalidAuthenticationToSignElectronically\": true,\n \"requirePixAuthenticationToSignElectronically\": true,\n \"requiredCertificateTypeToSign\": \"A1\",\n \"requireCompanyCertificate\": true,\n \"requiredCompanyIdentifier\": \"string\",\n \"requiredCertificateHolderTypeToSign\": \"Individual\",\n \"refusalReason\": \"string\",\n \"signatureInitialsMode\": \"None\",\n \"isElectronic\": true,\n \"allowRuleFlowToContinueIfRefused\": true,\n \"type\": \"Signer\",\n \"status\": \"Created\",\n \"step\": 0,\n \"ruleName\": \"string\",\n \"title\": \"string\"\n }\n ],\n \"observers\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"user\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"email\": \"user@example.com\",\n \"phone\": \"string\"\n }\n }\n ],\n \"attachments\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"filename\": \"string\",\n \"fileSize\": 0,\n \"mimeType\": \"string\",\n \"creationDate\": \"2024-07-29T13:38:34.829Z\",\n \"updateDate\": \"2024-07-29T13:38:34.829Z\",\n \"createdBy\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\"\n },\n \"isPrivate\": true\n }\n ],\n \"permissions\": {\n \"move\": true,\n \"editFlow\": true\n },\n \"notifiedEmails\": [\n \"string\"\n ],\n \"key\": \"string\",\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"filename\": \"string\",\n \"fileSize\": 0,\n \"mimeType\": \"string\",\n \"hasSignature\": true,\n \"status\": \"Pending\",\n \"isConcluded\": true,\n \"folder\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"parentId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n },\n \"organization\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"identifier\": \"string\",\n \"owner\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\"\n }\n },\n \"creationDate\": \"2024-07-29T13:38:34.829Z\",\n \"updateDate\": \"2024-07-29T13:38:34.829Z\",\n \"expirationDate\": \"2024-07-29T13:38:34.829Z\",\n \"expirationDateWithoutTime\": \"string\",\n \"createdBy\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\"\n },\n \"description\": \"string\",\n \"forceCadesSignature\": true,\n \"isScanned\": true,\n \"isEnvelope\": true,\n \"statusUpdatedBy\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"type\": \"User\",\n \"name\": \"string\"\n },\n \"statusUpdateReason\": \"string\",\n \"tags\": [\n {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"label\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"signatureType\": \"None\",\n \"securityContext\": {\n \"id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"string\",\n \"englishName\": \"string\",\n \"portugueseName\": \"string\",\n \"spanishName\": \"string\",\n \"allowDigitalSignature\": true,\n \"allowedElectronicTypes\": {\n \"sms\": true,\n \"whatsapp\": true,\n \"otp\": true,\n \"selfie\": true,\n \"datavalid\": true,\n \"pix\": true,\n \"email\": true\n }\n }\n}" } }, "schema": { "type": "object", "properties": { "checksumMd5": { "type": "string", "example": "string" }, "isDeleted": { "type": "boolean", "example": true, "default": true }, "flowActions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "creationDate": { "type": "string", "example": "2024-07-29T13:38:34.829Z" }, "pendingDate": { "type": "string", "example": "2024-07-29T13:38:34.829Z" }, "updateDate": { "type": "string", "example": "2024-07-29T13:38:34.829Z" }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name": { "type": "string", "example": "string" }, "identifier": { "type": "string", "example": "string" }, "email": { "type": "string", "example": "user@example.com" }, "phone": { "type": "string", "example": "string" } } }, "numberRequiredSignatures": { "type": "integer", "example": 0, "default": 0 }, "signRuleUsers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name": { "type": "string", "example": "string" }, "identifier": { "type": "string", "example": "string" }, "email": { "type": "string", "example": "string" }, "phone": { "type": "string", "example": "string" }, "signatureDate": { "type": "string", "example": "2024-07-29T13:38:34.829Z" }, "isElectronic": { "type": "boolean", "example": true, "default": true }, "refusalDate": { "type": "string", "example": "2024-07-29T13:38:34.829Z" }, "hasRefused": { "type": "boolean", "example": true, "default": true }, "refusalReason": { "type": "string", "example": "string" } } } }, "marks": { "type": "array", "items": { "type": "object", "properties": { "topLeftX": { "type": "integer", "example": 0, "default": 0 }, "topLeftY": { "type": "integer", "example": 0, "default": 0 }, "width": { "type": "integer", "example": 0, "default": 0 }, "height": { "type": "integer", "example": 0, "default": 0 }, "pageNumber": { "type": "integer", "example": 0, "default": 0 }, "type": { "type": "string", "example": "SignatureVisualRepresentation" } } } }, "allowElectronicSignature": { "type": "boolean", "example": true, "default": true }, "requireEmailAuthenticationToSignElectronically": { "type": "boolean", "example": true, "default": true }, "requireSmsAuthenticationToSignElectronically": { "type": "boolean", "example": true, "default": true }, "requireWhatsappAuthenticationToSignElectronically": { "type": "boolean", "example": true, "default": true }, "requireAuthenticatorAppToSignElectronically": { "type": "boolean", "example": true, "default": true }, "requireSelfieAuthenticationToSignElectronically": { "type": "boolean", "example": true, "default": true }, "requireDatavalidAuthenticationToSignElectronically": { "type": "boolean", "example": true, "default": true }, "requirePixAuthenticationToSignElectronically": { "type": "boolean", "example": true, "default": true }, "requiredCertificateTypeToSign": { "type": "string", "example": "A1" }, "requireCompanyCertificate": { "type": "boolean", "example": true, "default": true }, "requiredCompanyIdentifier": { "type": "string", "example": "string" }, "requiredCertificateHolderTypeToSign": { "type": "string", "example": "Individual" }, "refusalReason": { "type": "string", "example": "string" }, "signatureInitialsMode": { "type": "string", "example": "None" }, "isElectronic": { "type": "boolean", "example": true, "default": true }, "allowRuleFlowToContinueIfRefused": { "type": "boolean", "example": true, "default": true }, "type": { "type": "string", "example": "Signer" }, "status": { "type": "string", "example": "Created" }, "step": { "type": "integer", "example": 0, "default": 0 }, "ruleName": { "type": "string", "example": "string" }, "title": { "type": "string", "example": "string" } } } }, "observers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "user": { "type": "object", "properties": { "id": { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name": { "type": "string", "example": "string" }, "identifier": { "type": "string", "example": "string" }, "email": { "type": "string", "example": "user@example.com" }, "phone": { "type": "string", "example": "string" } } } } } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name": { "type": "string", "example": "string" }, "filename": { "type": "string", "example": "string" }, "fileSize": { "type": "integer", "example": 0, "default": 0 }, "mimeType": { "type": "string", "example": "string" }, "creationDate": { "type": "string", "example": "2024-07-29T13:38:34.829Z" }, "updateDate": { "type": "string", "example": "2024-07-29T13:38:34.829Z" }, "createdBy": { "type": "object", "properties": { "id": { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name": { "type": "string", "example": "string" } } }, "isPrivate": { "type": "boolean", "example": true, "default": true } } } }, "permissions": { "type": "object", "properties": { "move": { "type": "boolean", "example": true, "default": true }, "editFlow": { "type": "boolean", "example": true, "default": true } } }, "notifiedEmails": { "type": "array", "items": { "type": "string", "example": "string" } }, "key": { "type": "string", "example": "string" }, "id": { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name": { "type": "string", "example": "string" }, "filename": { "type": "string", "example": "string" }, "fileSize": { "type": "integer", "example": 0, "default": 0 }, "mimeType": { "type": "string", "example": "string" }, "hasSignature": { "type": "boolean", "example": true, "default": true }, "status": { "type": "string", "example": "Pending" }, "isConcluded": { "type": "boolean", "example": true, "default": true }, "folder": { "type": "object", "properties": { "id": { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name": { "type": "string", "example": "string" }, "parentId": { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } }, "organization": { "type": "object", "properties": { "id": { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name": { "type": "string", "example": "string" }, "identifier": { "type": "string", "example": "string" }, "owner": { "type": "object", "properties": { "id": { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name": { "type": "string", "example": "string" } } } } }, "creationDate": { "type": "string", "example": "2024-07-29T13:38:34.829Z" }, "updateDate": { "type": "string", "example": "2024-07-29T13:38:34.829Z" }, "expirationDate": { "type": "string", "example": "2024-07-29T13:38:34.829Z" }, "expirationDateWithoutTime": { "type": "string", "example": "string" }, "createdBy": { "type": "object", "properties": { "id": { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name": { "type": "string", "example": "string" } } }, "description": { "type": "string", "example": "string" }, "forceCadesSignature": { "type": "boolean", "example": true, "default": true }, "isScanned": { "type": "boolean", "example": true, "default": true }, "isEnvelope": { "type": "boolean", "example": true, "default": true }, "statusUpdatedBy": { "type": "object", "properties": { "id": { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "type": { "type": "string", "example": "User" }, "name": { "type": "string", "example": "string" } } }, "statusUpdateReason": { "type": "string", "example": "string" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "label": { "type": "string", "example": "string" }, "value": { "type": "string", "example": "string" } } } }, "signatureType": { "type": "string", "example": "None" }, "securityContext": { "type": "object", "properties": { "id": { "type": "string", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name": { "type": "string", "example": "string" }, "englishName": { "type": "string", "example": "string" }, "portugueseName": { "type": "string", "example": "string" }, "spanishName": { "type": "string", "example": "string" }, "allowDigitalSignature": { "type": "boolean", "example": true, "default": true }, "allowedElectronicTypes": { "type": "object", "properties": { "sms": { "type": "boolean", "example": true, "default": true }, "whatsapp": { "type": "boolean", "example": true, "default": true }, "otp": { "type": "boolean", "example": true, "default": true }, "selfie": { "type": "boolean", "example": true, "default": true }, "datavalid": { "type": "boolean", "example": true, "default": true }, "pix": { "type": "boolean", "example": true, "default": true }, "email": { "type": "boolean", "example": true, "default": true } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "401": { "description": "401", "content": { "text/plain": { "examples": { "Result": { "value": "" } } } } }, "403": { "description": "403", "content": { "text/plain": { "examples": { "Result": { "value": "" } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"details\": {\n \"additionalProp1\": \"string\",\n \"additionalProp2\": \"string\",\n \"additionalProp3\": \"string\"\n }\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "string" }, "message": { "type": "string", "example": "string" }, "details": { "type": "object", "properties": { "additionalProp1": { "type": "string", "example": "string" }, "additionalProp2": { "type": "string", "example": "string" }, "additionalProp3": { "type": "string", "example": "string" } } } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true, "_id": "66a7942d175668001002943d:66a79f03d052010019d17ac4" } ```