{ "_type": "export", "__export_format": 4, "__export_date": "2026-09-29T21:08:54.329770+00:00", "__export_source": "ideia-signer:swagger-to-insomnia", "resources": [ { "_id": "wrk_ideiasigner", "_type": "workspace", "parentId": null, "name": "Ideia Signer — API", "description": "API do Ideia Signer (assinatura eletrônica e digital).\n\n**Base URL:** https://app.ideiasigner.com.br\n**Autenticação:** header `X-Api-Key: sua-app|` — preencha a variável `apiKey`.\n\nO caminho mínimo para colocar um documento em assinatura é:\n`POST /api/uploads` (envia o arquivo) -> `POST /api/documents` (cria o documento e o fluxo).\n\nComece pela pasta **00. Fluxo de assinatura (na ordem)**.\n\nGerado a partir de https://app.ideiasigner.com.br/swagger/api/swagger.json\n", "scope": "collection", "created": 1790716134327, "modified": 1790716134327 }, { "_id": "env_ideiasigner_base", "_type": "environment", "parentId": "wrk_ideiasigner", "name": "Base Environment", "data": { "baseUrl": "https://app.ideiasigner.com.br", "apiKey": "sua-app|xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "uploadId": "", "documentId": "", "documentKey": "", "flowActionId": "", "flowId": "", "folderId": "", "contactId": "", "userId": "", "marksSessionId": "", "fileName": "Contrato.pdf", "displayName": "Contrato de prestação de serviços", "contentType": "application/pdf", "signerName": "João da Silva", "signerEmail": "joao.silva@mailinator.com", "signerCpf": "81976153069", "signerPhone": "+55 11 91234-5678" }, "dataPropertyOrder": { "&": [ "baseUrl", "apiKey", "uploadId", "documentId", "documentKey", "flowActionId", "flowId", "folderId", "contactId", "userId", "marksSessionId", "fileName", "displayName", "contentType", "signerName", "signerEmail", "signerCpf", "signerPhone" ] }, "color": null, "isPrivate": false, "metaSortKey": 1790716134327, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "jar_ideiasigner", "_type": "cookie_jar", "parentId": "wrk_ideiasigner", "name": "Default Jar", "cookies": [], "created": 1790716134327, "modified": 1790716134327 }, { "_id": "fld_ideiasigner_fluxo", "_type": "request_group", "parentId": "wrk_ideiasigner", "name": "00. Fluxo de assinatura (na ordem)", "description": "Execute de cima para baixo, copiando o id devolvido em cada passo para a variável do ambiente (uploadId, documentId).", "environment": {}, "environmentPropertyOrder": null, "authentication": {}, "metaSortKey": -1790716134327, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_dd1861f50c7753dbaff76eb5a0a70c5d", "_type": "request", "parentId": "fld_ideiasigner_fluxo", "name": "Passo 1 — Enviar o arquivo (POST /api/uploads)", "method": "POST", "url": "{{ _.baseUrl }}/api/uploads", "description": "Envia o PDF em multipart/form-data. Selecione o arquivo no campo `file` antes de disparar.\n\nO `id` devolvido aqui é o que alimenta `files[].id` do passo 2.\n\n---\n\n**Uploads a file by sending a multipart/form-data request**\n\nThe id returned by this API should be used as paremeter to other APIs.\nYou may also use the location property to display a preview of the uploaded file.\n\nResposta 200: `FileModel`\n\n`POST /api/uploads`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "multipart/form-data", "params": [ { "id": "pair_file", "name": "file", "value": "", "type": "file", "fileName": "", "description": "Arquivo a enviar (PDF, XML, etc.)" } ] }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716134327, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_03cba4b173425cb3a5b4b470c1a80ee4", "_type": "request", "parentId": "fld_ideiasigner_fluxo", "name": "Passo 1b — Enviar o arquivo em Base64 (POST /api/uploads/bytes)", "method": "POST", "url": "{{ _.baseUrl }}/api/uploads/bytes", "description": "Alternativa ao passo 1 quando é mais fácil mandar os bytes em Base64 do que um multipart. Devolve o mesmo `id`, mais `size` e `digest` (MD5) para conferência de integridade.\n\n---\n\n**Uploads a file by sending a JSON request with the bytes in Base 64 format.**\n\nBody: `Uploads.UploadBytesRequest`\n\nResposta 200: `Uploads.UploadBytesModel`\n\n`POST /api/uploads/bytes`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"bytes\": \"JVBERi0xLjQK...\"\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716134326, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_f372a531adfd50febbe0acf783e6c0c1", "_type": "request", "parentId": "fld_ideiasigner_fluxo", "name": "Passo 2 — Criar o documento (POST /api/documents)", "method": "POST", "url": "{{ _.baseUrl }}/api/documents", "description": "Cria um documento por arquivo listado em `files` e monta o fluxo de assinatura em `flowActions`.\n\nA resposta é uma lista de `{ uploadId, documentId }`. O e-mail de ação pendente sai automaticamente para os participantes do passo 1 do fluxo (a menos que você use `disablePendingActionNotifications`).\n\n---\n\n**Creates one or multiple documents.**\n\nBefore calling this API you need to upload the file(s) using the Upload API or the Upload Bytes API. \n\nWhen creating a big batch of documents, it is recommended to send multiple requests instead of one big request. For instance, if you want to create 100 documents, \nsend 10 requests of 10 documents. In this case it is recommended to use the disablePendingActionNotifications option and, when all requests are finished, use the \nusers/notify-pending API to notify participants.\n\nReturns a list of ids of each document created.\n\nBody: `Documents.CreateDocumentRequest`\n\nResposta 200: `Documents.CreateDocumentResult[]`\n\n`POST /api/documents`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"files\": [\n {\n \"displayName\": \"{{ _.displayName }}\",\n \"id\": \"{{ _.uploadId }}\",\n \"name\": \"{{ _.fileName }}\",\n \"contentType\": \"{{ _.contentType }}\"\n }\n ],\n \"description\": \"Documento criado via API\",\n \"flowActions\": [\n {\n \"type\": \"Signer\",\n \"step\": 1,\n \"title\": \"Contratante\",\n \"user\": {\n \"name\": \"{{ _.signerName }}\",\n \"identifierType\": \"Cpf\",\n \"identifier\": \"{{ _.signerCpf }}\",\n \"email\": \"{{ _.signerEmail }}\",\n \"phone\": \"{{ _.signerPhone }}\"\n },\n \"allowElectronicSignature\": true,\n \"requireSmsAuthenticationToSignElectronically\": false\n }\n ],\n \"disableNotifications\": false,\n \"disablePendingActionNotifications\": false\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716134325, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_11b533bb0a815887903da07df6a174f6", "_type": "request", "parentId": "fld_ideiasigner_fluxo", "name": "Passo 3 — Consultar o documento (GET /api/documents/{id})", "method": "GET", "url": "{{ _.baseUrl }}/api/documents/{{ _.documentId }}", "description": "Confere o status do documento e devolve os `flowActions` com seus ids — use o `id` da ação quando precisar informar `flowActionId`.\n\n---\n\n**Retrieves the document's details.**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | Document id |\n\nResposta 200: `Documents.DocumentModel`\n\n`GET /api/documents/{id}`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716134324, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_4046fe22f7ae57e7b2dabfef5bdd1552", "_type": "request", "parentId": "fld_ideiasigner_fluxo", "name": "Passo 4 — Link de assinatura do participante (POST /api/documents/{id}/action-url)", "method": "POST", "url": "{{ _.baseUrl }}/api/documents/{{ _.documentId }}/action-url", "description": "Opcional. Só é necessário se você quiser levar o signatário direto para a tela de assinatura (redirect via `url` ou iframe via `embedUrl`), em vez de depender do e-mail enviado pelo Signer.\n\n---\n\n**Retrieves an URL to redirect the user to the first pending action of the document.**\n\nThis API will return an URL that allows an user to sign or approve the document without having to wait to receive an email notification.\n\nIf the document has multiple pending actions, this API will return the URL of the first pending action for the matched user.\n\nAfter the action has been completed, you may call this API again to retrieve the URL for the next action (if any).\n\nPlease note that using the URL returned will be recorded in the evidences of the action as an Application Authentication.\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | Document Id |\n\nBody: `Documents.ActionUrlRequest`\n\nResposta 200: `Documents.ActionUrlResponse`\n\n`POST /api/documents/{id}/action-url`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"identifier\": \"{{ _.signerCpf }}\",\n \"emailAddress\": \"{{ _.signerEmail }}\",\n \"requireEmailAuthentication\": false\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716134323, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_77180d08e8fc50ed876b2cae4a5375bb", "_type": "request", "parentId": "fld_ideiasigner_fluxo", "name": "Passo 5 — Acompanhar as assinaturas (GET /api/documents/{id}/signatures-details)", "method": "GET", "url": "{{ _.baseUrl }}/api/documents/{{ _.documentId }}/signatures-details", "description": "Mostra quem já assinou, quando e com que tipo de assinatura. Para produção prefira o webhook `DocumentConcluded` em vez de ficar consultando em loop.\n\n---\n\n**Retrieves the details of the document's signatures.**\n\nThis will perform the same validations as verifying the document signatures using the verification code.\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | The Id of the document |\n\nResposta 200: `Documents.DocumentSignaturesInfoModel`\n\n`GET /api/documents/{id}/signatures-details`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716134322, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_2d69429c208156a7a3ed43509deb7999", "_type": "request", "parentId": "fld_ideiasigner_fluxo", "name": "Passo 6 — Baixar o PDF assinado (GET /api/documents/{id}/content)", "method": "GET", "url": "{{ _.baseUrl }}/api/documents/{{ _.documentId }}/content", "description": "`type=Signatures` devolve o PDF com as assinaturas. Outros valores úteis: `Original`, `PrinterFriendlyVersion`, `SignaturesManifest`.\n\nSe preferir uma URL temporária em vez do binário, use `GET /api/documents/{id}/ticket`.\n\n---\n\n**Downloads a specific version type of the document.**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | Document id |\n| `type` | query | Original/PrinterFriendlyVersion/Signatures/OriginalWithMarks/SigningTags/SignatureMarks/SignaturesManifest | The version type to download |\n\n`GET /api/documents/{id}/content`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [ { "id": "pair_type", "name": "type", "value": "Signatures", "description": "", "disabled": false } ], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716134321, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "fld_ideiasigner_upload", "_type": "request_group", "parentId": "wrk_ideiasigner", "name": "1. Upload de arquivos", "description": "", "environment": {}, "environmentPropertyOrder": null, "authentication": {}, "metaSortKey": -1790716133327, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_72b719f062c45a3bbe9053b66f429ef4", "_type": "request", "parentId": "fld_ideiasigner_upload", "name": "POST uploads/bytes — Uploads a file by sending a JSON request with the bytes in Base 64 format", "method": "POST", "url": "{{ _.baseUrl }}/api/uploads/bytes", "description": "**Uploads a file by sending a JSON request with the bytes in Base 64 format.**\n\nBody: `Uploads.UploadBytesRequest`\n\nResposta 200: `Uploads.UploadBytesModel`\n\n`POST /api/uploads/bytes`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"bytes\": \"JVBERi0xLjQK...\"\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716133327, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_5a1deccf10515c9d8db98974385b657a", "_type": "request", "parentId": "fld_ideiasigner_upload", "name": "POST uploads — Uploads a file by sending a multipart/form-data request", "method": "POST", "url": "{{ _.baseUrl }}/api/uploads", "description": "**Uploads a file by sending a multipart/form-data request**\n\nThe id returned by this API should be used as paremeter to other APIs.\nYou may also use the location property to display a preview of the uploaded file.\n\nResposta 200: `FileModel`\n\n`POST /api/uploads`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "multipart/form-data", "params": [ { "id": "pair_file", "name": "file", "value": "", "type": "file", "fileName": "", "description": "Arquivo a enviar (PDF, XML, etc.)" } ] }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716133326, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "fld_ideiasigner_documents", "_type": "request_group", "parentId": "wrk_ideiasigner", "name": "2. Documentos", "description": "", "environment": {}, "environmentPropertyOrder": null, "authentication": {}, "metaSortKey": -1790716132327, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_c288207ad8665507ad9d8a5f6cc40720", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "GET documents/{id} — Retrieves the document's details", "method": "GET", "url": "{{ _.baseUrl }}/api/documents/{{ _.documentId }}", "description": "**Retrieves the document's details.**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | Document id |\n\nResposta 200: `Documents.DocumentModel`\n\n`GET /api/documents/{id}`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132327, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_9bb666641efc55ce949093bf33aa71ea", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "DELETE documents/{id} — Deletes a specific document using it's id", "method": "DELETE", "url": "{{ _.baseUrl }}/api/documents/{{ _.documentId }}", "description": "**Deletes a specific document using it's id.**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | Document id |\n\n`DELETE /api/documents/{id}`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132326, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_96a3196d57fc58d0b4d7a509ff66bdab", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "POST documents/{id}/action-url — Retrieves an URL to redirect the user to the first pending action of the document", "method": "POST", "url": "{{ _.baseUrl }}/api/documents/{{ _.documentId }}/action-url", "description": "**Retrieves an URL to redirect the user to the first pending action of the document.**\n\nThis API will return an URL that allows an user to sign or approve the document without having to wait to receive an email notification.\n\nIf the document has multiple pending actions, this API will return the URL of the first pending action for the matched user.\n\nAfter the action has been completed, you may call this API again to retrieve the URL for the next action (if any).\n\nPlease note that using the URL returned will be recorded in the evidences of the action as an Application Authentication.\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | Document Id |\n\nBody: `Documents.ActionUrlRequest`\n\nResposta 200: `Documents.ActionUrlResponse`\n\n`POST /api/documents/{id}/action-url`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"identifier\": \"\",\n \"emailAddress\": \"\",\n \"requireEmailAuthentication\": false,\n \"flowActionId\": \"00000000-0000-0000-0000-000000000000\"\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132325, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_6a5c54c35bd35d8da2f26f385551bc16", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "POST documents/{id}/flow — Updates the document's flow", "method": "POST", "url": "{{ _.baseUrl }}/api/documents/{{ _.documentId }}/flow", "description": "**Updates the document's flow.**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | Id of the document |\n\nBody: `Documents.DocumentFlowEditRequest`\n\nResposta 200: `FlowActions.DocumentFlowEditResponse`\n\n`POST /api/documents/{id}/flow`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"addedFlowActions\": [\n {\n \"user\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"\",\n \"identifierType\": {},\n \"identifier\": \"\",\n \"identifiers\": [],\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"ruleUsers\": [\n {}\n ],\n \"type\": \"Signer\",\n \"numberRequiredActions\": 0,\n \"allowRuleFlowToContinueIfRefused\": false,\n \"xadesOptions\": {\n \"signatureType\": {},\n \"elementToSignIdentifierType\": {},\n \"elementToSignIdentifier\": \"\",\n \"insertionOption\": {},\n \"disableXPathTransformation\": false\n },\n \"step\": 0,\n \"ruleName\": \"\",\n \"title\": \"\",\n \"prePositionedMarks\": [\n {}\n ],\n \"allowElectronicSignature\": false,\n \"requireSmsAuthenticationToSignElectronically\": false,\n \"requireWhatsappAuthenticationToSignElectronically\": false,\n \"requireAuthenticatorAppToSignElectronically\": false,\n \"requireSelfieAuthenticationToSignElectronically\": false,\n \"requireDatavalidAuthenticationToSignElectronically\": false,\n \"requirePixAuthenticationToSignElectronically\": false,\n \"requireLivenessAuthenticationToSignElectronically\": false,\n \"requireIdScanAuthenticationToSignElectronically\": false,\n \"disableEmailAuthenticationToSignElectronically\": false,\n \"requiredCertificateTypeToSign\": \"A1\",\n \"requireCompanyCertificate\": false,\n \"requiredCompanyIdentifier\": \"\",\n \"requiredCertificateHolderTypeToSign\": \"Individual\",\n \"allowIdrcSignature\": false,\n \"signatureInitialsMode\": \"None\",\n \"notificationLanguage\": \"Pt\"\n }\n ],\n \"editedFlowActions\": [\n {\n \"flowActionId\": \"00000000-0000-0000-0000-000000000000\",\n \"participantEmailAddress\": \"\",\n \"participantPhoneNumber\": \"\",\n \"ruleUsers\": [\n {}\n ],\n \"addedRuleUsers\": [\n {}\n ],\n \"deletedRuleUserIds\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"identifierType\": \"Cpf\",\n \"step\": 0,\n \"ruleName\": \"\",\n \"title\": \"\",\n \"prePositionedMarks\": [\n {}\n ],\n \"allowElectronicSignature\": false,\n \"requireSmsAuthenticationToSignElectronically\": false,\n \"requireWhatsappAuthenticationToSignElectronically\": false,\n \"requireAuthenticatorAppToSignElectronically\": false,\n \"requireSelfieAuthenticationToSignElectronically\": false,\n \"requireDatavalidAuthenticationToSignElectronically\": false,\n \"requirePixAuthenticationToSignElectronically\": false,\n \"requireLivenessAuthenticationToSignElectronically\": false,\n \"requireIdScanAuthenticationToSignElectronically\": false,\n \"disableEmailAuthenticationToSignElectronically\": false,\n \"requiredCertificateTypeToSign\": \"A1\",\n \"requireCompanyCertificate\": false,\n \"requiredCompanyIdentifier\": \"\",\n \"requiredCertificateHolderTypeToSign\": \"Individual\",\n \"allowIdrcSignature\": false,\n \"signatureInitialsMode\": \"None\",\n \"notificationLanguage\": \"Pt\"\n }\n ],\n \"deletedFlowActionIds\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"addedObservers\": [\n {\n \"user\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"\",\n \"identifierType\": {},\n \"identifier\": \"\",\n \"identifiers\": [],\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"notificationLanguage\": \"Pt\"\n }\n ],\n \"editedObservers\": [\n {\n \"observerId\": \"00000000-0000-0000-0000-000000000000\",\n \"emailAddress\": \"\",\n \"notificationLanguage\": \"Pt\"\n }\n ],\n \"deletedObserverIds\": [\n \"00000000-0000-0000-0000-000000000000\"\n ]\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132324, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_c6d0f9a663a553c68406cacba4376d94", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "PUT documents/{id}/notified-emails — Updates the document's notified emails", "method": "PUT", "url": "{{ _.baseUrl }}/api/documents/{{ _.documentId }}/notified-emails", "description": "**Updates the document's notified emails**\n\nThe notified emails are the ones that will be notified after the document is concluded.\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | Id of the document |\n\nBody: `Documents.DocumentNotifiedEmailsEditRequest`\n\n`PUT /api/documents/{id}/notified-emails`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"emails\": [\n \"\"\n ]\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132323, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_879394805c735470858b6c7a62f0cdfb", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "GET documents — Retrieves the documents of the organization paginating the response", "method": "GET", "url": "{{ _.baseUrl }}/api/documents", "description": "**Retrieves the documents of the organization paginating the response.**\n\nYou may filter the documents by folder and document type.\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `IsConcluded` | query | boolean | (DEPRECATED) Please use \"Status\" parameter instead. Set to true to list concluded documents, false to list pending documents. |\n| `Status` | query | PendingOrRefused/Concluded/CanceledOrExpired/Pending/Refused/Canceled/Expired | Filters by document status. Will override the \"IsConcluded\" property. |\n| `FolderId` | query | string | |\n| `FolderType` | query | Normal/WithoutFolder | |\n| `DocumentType` | query | Deed/PowerOfAttorney/Prescription/MedicalCertificate/ExamRequest/LabReport/DischargeSummary/ClinicalRecord/DrugDispensing/Vaccination/MedicalReport | |\n| `FilterByDocumentType` | query | boolean | True if the documents should be filtered by type, use documentType to specify the document type. |\n| `FilterByPendingSignature` | query | boolean | True if documents should be filtered only for those that have FlowAction of the type Signer or SignRule |\n| `QueryType` | query | Name/Key/Id/CreatorName/Tag | |\n| `ParticipantQ` | query | string | Query to filter by participant |\n| `ParticipantQueryType` | query | Name/Identifier/Email/Phone | |\n| `Tags` | query | string | Label/value pairs are separated by \"|\" (optional) and Tags separated by \",\". Only the first 10 pairs will be considered. |\n| `IsDeleted` | query | boolean | Returns deleted documents that had the specified document status when deleted. |\n| `Q` | query | string | Query to filter items. |\n| `Limit` | query | integer | Number of items to return. |\n| `Offset` | query | integer | The offset of the searched page (starting with 0). |\n| `Order` | query | Asc/Desc | |\n\nResposta 200: `PaginatedSearchResponse[Documents.DocumentListModel]`\n\n`GET /api/documents`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [ { "id": "pair_IsConcluded", "name": "IsConcluded", "value": "", "description": "(DEPRECATED) Please use \"Status\" parameter instead. Set to true to list concluded documents, false to list pending documents.", "disabled": true }, { "id": "pair_Status", "name": "Status", "value": "PendingOrRefused", "description": "Filters by document status. Will override the \"IsConcluded\" property.", "disabled": true }, { "id": "pair_FolderId", "name": "FolderId", "value": "", "description": "", "disabled": true }, { "id": "pair_FolderType", "name": "FolderType", "value": "Normal", "description": "", "disabled": true }, { "id": "pair_DocumentType", "name": "DocumentType", "value": "Deed", "description": "", "disabled": true }, { "id": "pair_FilterByDocumentType", "name": "FilterByDocumentType", "value": "", "description": "True if the documents should be filtered by type, use documentType to specify the document type.\nIf you want to filter only documents without a type, set this parameter to true and the documentType to null.", "disabled": true }, { "id": "pair_FilterByPendingSignature", "name": "FilterByPendingSignature", "value": "", "description": "True if documents should be filtered only for those that have FlowAction of the type Signer or SignRule", "disabled": true }, { "id": "pair_QueryType", "name": "QueryType", "value": "Name", "description": "", "disabled": true }, { "id": "pair_ParticipantQ", "name": "ParticipantQ", "value": "", "description": "Query to filter by participant", "disabled": true }, { "id": "pair_ParticipantQueryType", "name": "ParticipantQueryType", "value": "Name", "description": "", "disabled": true }, { "id": "pair_Tags", "name": "Tags", "value": "", "description": "Label/value pairs are separated by \"|\" (optional) and Tags separated by \",\". Only the first 10 pairs will be considered.\nTo search by tag value only, do not use the \"|\".", "disabled": true }, { "id": "pair_IsDeleted", "name": "IsDeleted", "value": "", "description": "Returns deleted documents that had the specified document status when deleted.", "disabled": true }, { "id": "pair_Q", "name": "Q", "value": "", "description": "Query to filter items.", "disabled": true }, { "id": "pair_Limit", "name": "Limit", "value": "", "description": "Number of items to return.", "disabled": true }, { "id": "pair_Offset", "name": "Offset", "value": "", "description": "The offset of the searched page (starting with 0).", "disabled": true }, { "id": "pair_Order", "name": "Order", "value": "Asc", "description": "", "disabled": true } ], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132322, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_6753961be8cc58e9bfc3fad1d74b60a0", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "POST documents — Creates one or multiple documents", "method": "POST", "url": "{{ _.baseUrl }}/api/documents", "description": "**Creates one or multiple documents.**\n\nBefore calling this API you need to upload the file(s) using the Upload API or the Upload Bytes API. \n\nWhen creating a big batch of documents, it is recommended to send multiple requests instead of one big request. For instance, if you want to create 100 documents, \nsend 10 requests of 10 documents. In this case it is recommended to use the disablePendingActionNotifications option and, when all requests are finished, use the \nusers/notify-pending API to notify participants.\n\nReturns a list of ids of each document created.\n\nBody: `Documents.CreateDocumentRequest`\n\nResposta 200: `Documents.CreateDocumentResult[]`\n\n`POST /api/documents`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"files\": [\n {\n \"displayName\": \"Contrato Swagger\",\n \"id\": \"0429c723-a66d-4e55-a912-ff636d1b2745\",\n \"name\": \"Contrato.pdf\",\n \"contentType\": \"application/pdf\"\n }\n ],\n \"flowActions\": [\n {\n \"type\": \"Signer\",\n \"step\": 1,\n \"user\": {\n \"name\": \"John Wick\",\n \"identifier\": \"81976153069\",\n \"email\": \"john.wick@mailinator.com\"\n }\n }\n ]\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132321, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_d8390ba21fd25ffb8c649184df83371f", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "POST documents/{id}/cancellation — Cancels the document by providing a reason for the cancellation", "method": "POST", "url": "{{ _.baseUrl }}/api/documents/{{ _.documentId }}/cancellation", "description": "**Cancels the document by providing a reason for the cancellation.**\n\nCAUTION: This action cannot be reverted.\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | |\n\nBody: `Documents.CancelDocumentRequest`\n\n`POST /api/documents/{id}/cancellation`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"reason\": \"\"\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132320, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_34e2c4000b9c59d89a4cf97671edfccd", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "POST documents/{id}/folder — Moves a document to a folder", "method": "POST", "url": "{{ _.baseUrl }}/api/documents/{{ _.documentId }}/folder", "description": "**Moves a document to a folder.**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | |\n\nBody: `Documents.MoveDocumentRequest`\n\n`POST /api/documents/{id}/folder`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"folderId\": \"00000000-0000-0000-0000-000000000000\",\n \"newFolderName\": \"\"\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132319, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_4bb3073a81e95ebeb655ef59413e412c", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "POST documents/batch/folder — Moves a batch of documents to a folder", "method": "POST", "url": "{{ _.baseUrl }}/api/documents/batch/folder", "description": "**Moves a batch of documents to a folder.**\n\nBody: `Documents.MoveDocumentBatchRequest`\n\nResposta 200: `BatchItemResultModel[]`\n\n`POST /api/documents/batch/folder`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"documents\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"folderId\": \"00000000-0000-0000-0000-000000000000\",\n \"newFolderName\": \"\"\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132318, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_2f373d18292a5cc08cb6de7e160826d1", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "GET documents/{id}/signatures-details — Retrieves the details of the document's signatures", "method": "GET", "url": "{{ _.baseUrl }}/api/documents/{{ _.documentId }}/signatures-details", "description": "**Retrieves the details of the document's signatures.**\n\nThis will perform the same validations as verifying the document signatures using the verification code.\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | The Id of the document |\n\nResposta 200: `Documents.DocumentSignaturesInfoModel`\n\n`GET /api/documents/{id}/signatures-details`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132317, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_8e59cf7a4a1c51ccbc98acaf4700342f", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "GET documents/{id}/ticket — Generates a URL (ticket) to download a specific version type of the document", "method": "GET", "url": "{{ _.baseUrl }}/api/documents/{{ _.documentId }}/ticket", "description": "**Generates a URL (ticket) to download a specific version type of the document.**\n\nThe URL does not require authentication and will be available for 1 hour.\n\nOriginal: the original file provided when the document was created.OriginalWithMarks: the original file with all marks added (for example when an user approves the document and includes its signature image).PrinterFriendlyVersion: if the original document is PDF, the version with marks and a appended signature manifest, otherwise a PDF file with the signature manifest.Signatures: if the original document is PDF, the signed PDF file, otherwise the .p7s file.\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | Document id |\n| `type` | query | Original/PrinterFriendlyVersion/Signatures/OriginalWithMarks/SigningTags/SignatureMarks/SignaturesManifest | The version type to download |\n| `preview` | query | boolean | If true, when downloading the document, the response will not include the name of the file (useful when embedding the document inside a web page for previewing) |\n\nResposta 200: `TicketModel`\n\n`GET /api/documents/{id}/ticket`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [ { "id": "pair_type", "name": "type", "value": "Original", "description": "The version type to download", "disabled": true }, { "id": "pair_preview", "name": "preview", "value": "", "description": "If true, when downloading the document, the response will not include the name of the file (useful when embedding the document inside a web page for previewing)", "disabled": true } ], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132316, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_972c0e671263556698006018d4d6cd18", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "GET documents/{id}/content — Downloads a specific version type of the document", "method": "GET", "url": "{{ _.baseUrl }}/api/documents/{{ _.documentId }}/content", "description": "**Downloads a specific version type of the document.**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | Document id |\n| `type` | query | Original/PrinterFriendlyVersion/Signatures/OriginalWithMarks/SigningTags/SignatureMarks/SignaturesManifest | The version type to download |\n\n`GET /api/documents/{id}/content`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [ { "id": "pair_type", "name": "type", "value": "Original", "description": "The version type to download", "disabled": true } ], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132315, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_42cb3fff9741561cb135309dfa15dcf5", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "GET documents/{id}/content-b64 — Downloads a specific version type of the document encoding the bytes in Base 64 format", "method": "GET", "url": "{{ _.baseUrl }}/api/documents/{{ _.documentId }}/content-b64", "description": "**Downloads a specific version type of the document encoding the bytes in Base 64 format.**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | Document id |\n| `type` | query | Original/PrinterFriendlyVersion/Signatures/OriginalWithMarks/SigningTags/SignatureMarks/SignaturesManifest | The version type to download |\n\nResposta 200: `Documents.DocumentContentModel`\n\n`GET /api/documents/{id}/content-b64`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [ { "id": "pair_type", "name": "type", "value": "Original", "description": "The version type to download", "disabled": true } ], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132314, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_2714c3ac64375c098a32b2766d3df6ed", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "GET documents/keys/{key}/signatures — Validates each signature in a document using the verification code", "method": "GET", "url": "{{ _.baseUrl }}/api/documents/keys/{{ _.documentKey }}/signatures", "description": "**Validates each signature in a document using the verification code**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `key` | path | string | The verification code presented in the document |\n\nResposta 200: `Documents.DocumentSignaturesInfoModel`\n\n`GET /api/documents/keys/{key}/signatures`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132313, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_05945871787557029062406605779da1", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "POST documents/validate-signatures — Validates each signature in the uploaded document", "method": "POST", "url": "{{ _.baseUrl }}/api/documents/validate-signatures", "description": "**Validates each signature in the uploaded document**\n\nBefore calling this API you need to upload the file using the Upload API or the Upload Bytes API.\n\nBody: `Signature.SignaturesInfoRequest`\n\nResposta 200: `SignerModel[]`\n\n`POST /api/documents/validate-signatures`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"fileId\": \"00000000-0000-0000-0000-000000000000\",\n \"mimeType\": \"\",\n \"signatureType\": \"None\",\n \"securityContextId\": \"00000000-0000-0000-0000-000000000000\"\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132312, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_119275dd4dd95f47941b4c7cf1543633", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "POST documents/{id}/refusal — Refuses a document by providing a reason for the refusal", "method": "POST", "url": "{{ _.baseUrl }}/api/documents/{{ _.documentId }}/refusal", "description": "**Refuses a document by providing a reason for the refusal.**\n\nThe document's flow will pause and can only be resumed by adding a new version of the document (see Add Version API).\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | |\n\nBody: `Refusal.RefusalRequest`\n\n`POST /api/documents/{id}/refusal`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"reason\": \"\"\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132311, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_5c551ad99ea95f8e944509df1661322d", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "POST documents/{id}/versions — Adds a new version for the document", "method": "POST", "url": "{{ _.baseUrl }}/api/documents/{{ _.documentId }}/versions", "description": "**Adds a new version for the document.**\n\nThe flow of the document will be restarted. \n\nIf the document was created as an envelope, please use the Add Envelope Version API\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | |\n\nBody: `Documents.DocumentAddVersionRequest`\n\n`POST /api/documents/{id}/versions`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"file\": {\n \"displayName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"contentType\": \"\"\n },\n \"disablePendingActionNotifications\": false,\n \"additionalInfo\": {\n \"healthData\": {\n \"professional\": {\n \"id\": \"\",\n \"region\": \"\"\n },\n \"items\": [\n {}\n ]\n },\n \"fields\": {\n \"chave\": \"valor\"\n },\n \"metadata\": {\n \"chave\": \"valor\"\n }\n },\n \"prePositionedMarks\": [\n {\n \"flowActionId\": \"00000000-0000-0000-0000-000000000000\",\n \"prePositionedDocumentMarks\": [\n {}\n ]\n }\n ]\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132310, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_7b5b240e41c15c3c9500a9c37d00e91b", "_type": "request", "parentId": "fld_ideiasigner_documents", "name": "POST documents/{id}/envelope/versions — Adds a new version for an envelope", "method": "POST", "url": "{{ _.baseUrl }}/api/documents/{{ _.documentId }}/envelope/versions", "description": "**Adds a new version for an envelope.**\n\nThe flow of the document will be restarted.\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | |\n\nBody: `Documents.EnvelopeAddVersionRequest`\n\n`POST /api/documents/{id}/envelope/versions`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"files\": [\n {\n \"displayName\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"contentType\": \"\"\n }\n ],\n \"disablePendingActionNotifications\": false,\n \"additionalInfo\": {\n \"healthData\": {\n \"professional\": {\n \"id\": \"\",\n \"region\": \"\"\n },\n \"items\": [\n {}\n ]\n },\n \"fields\": {\n \"chave\": \"valor\"\n },\n \"metadata\": {\n \"chave\": \"valor\"\n }\n },\n \"prePositionedMarks\": [\n {\n \"flowActionId\": \"00000000-0000-0000-0000-000000000000\",\n \"prePositionedDocumentMarks\": [\n {}\n ]\n }\n ]\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716132309, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "fld_ideiasigner_markssessions", "_type": "request_group", "parentId": "wrk_ideiasigner", "name": "3. Sessões de marcas (posicionamento de assinatura)", "description": "", "environment": {}, "environmentPropertyOrder": null, "authentication": {}, "metaSortKey": -1790716131327, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_1d261cd50ebc5c179e37384ddded8d1e", "_type": "request", "parentId": "fld_ideiasigner_markssessions", "name": "GET marks-sessions/{id} — Retrieves session information", "method": "GET", "url": "{{ _.baseUrl }}/api/marks-sessions/{{ _.marksSessionId }}", "description": "**Retrieves session information.**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | The session ID obtained when the session was created |\n\nResposta 200: `DocumentMark.MarksSessionModel`\n\n`GET /api/marks-sessions/{id}`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716131327, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_98c5e4e07ed251128764ee5782ed6f54", "_type": "request", "parentId": "fld_ideiasigner_markssessions", "name": "POST marks-sessions — Creates a mark positioning session by requiring only the necessary data", "method": "POST", "url": "{{ _.baseUrl }}/api/marks-sessions", "description": "**Creates a mark positioning session by requiring only the necessary data.**\n\nThe purpose of the positioning session is to allow users to visually position signer marks.\nThe result of the session is the same request provided while creating it but with the flowAction's prePositioned marks attribute\nfilled according to the positions selected for each action.\n\nResult will be available by iFrame event when embedding the positioning session or by retrieving the session information via the GET API.\n\nBody: `DocumentMark.MarksSessionCreateRequest`\n\nResposta 200: `DocumentMark.MarksSessionCreateResponse`\n\n`POST /api/marks-sessions`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"files\": [\n {\n \"id\": \"0429c723-a66d-4e55-a912-ff636d1b2745\",\n \"name\": \"Contrato.pdf\",\n \"contentType\": \"application/pdf\"\n }\n ],\n \"isEnvelope\": false,\n \"flowActions\": [\n {\n \"type\": \"Signer\",\n \"step\": 1,\n \"user\": {\n \"name\": \"John Wick\",\n \"identifier\": \"81976153069\",\n \"email\": \"john.wick@mailinator.com\"\n },\n \"signatureInitialsMode\": \"None\"\n }\n ]\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716131326, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_8bc1055d28f356c691221ec8392b2f27", "_type": "request", "parentId": "fld_ideiasigner_markssessions", "name": "POST marks-sessions/documents — Creates a mark positioning session from a Document create request", "method": "POST", "url": "{{ _.baseUrl }}/api/marks-sessions/documents", "description": "**Creates a mark positioning session from a Document create request.**\n\nThe purpose of the positioning session is to allow users to visually position signer marks.\nThe result of the session is the same request provided while creating it but with the flowAction's prePositioned marks attribute\nfilled according to the positions selected for each action.\n\nResult will be available by iFrame event when embedding the positioning session or by retrieving the session information via the GET API.\n\nBody: `Documents.CreateDocumentRequest`\n\nResposta 200: `DocumentMark.MarksSessionCreateResponse`\n\n`POST /api/marks-sessions/documents`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"files\": [\n {\n \"displayName\": \"Contrato Swagger\",\n \"id\": \"0429c723-a66d-4e55-a912-ff636d1b2745\",\n \"name\": \"Contrato.pdf\",\n \"contentType\": \"application/pdf\"\n }\n ],\n \"flowActions\": [\n {\n \"type\": \"Signer\",\n \"step\": 1,\n \"user\": {\n \"name\": \"John Wick\",\n \"identifier\": \"81976153069\",\n \"email\": \"john.wick@mailinator.com\"\n }\n }\n ]\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716131325, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "fld_ideiasigner_flows", "_type": "request_group", "parentId": "wrk_ideiasigner", "name": "4. Fluxos reutilizáveis", "description": "", "environment": {}, "environmentPropertyOrder": null, "authentication": {}, "metaSortKey": -1790716130327, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_c23a6eb5363857dca36c153d6c223fbf", "_type": "request", "parentId": "fld_ideiasigner_flows", "name": "POST document-flows — Creates a flow that can be used to create documents", "method": "POST", "url": "{{ _.baseUrl }}/api/document-flows", "description": "**Creates a flow that can be used to create documents**\n\nBody: `DocumentFlows.DocumentFlowCreateRequest`\n\nResposta 200: `DocumentFlows.DocumentFlowModel`\n\n`POST /api/document-flows`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"name\": \"\",\n \"areActionsOrdered\": false,\n \"flowActions\": [\n {\n \"user\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"\",\n \"identifierType\": {},\n \"identifier\": \"\",\n \"identifiers\": [],\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"ruleUsers\": [\n {}\n ],\n \"type\": \"Signer\",\n \"numberRequiredActions\": 0,\n \"allowRuleFlowToContinueIfRefused\": false,\n \"xadesOptions\": {\n \"signatureType\": {},\n \"elementToSignIdentifierType\": {},\n \"elementToSignIdentifier\": \"\",\n \"insertionOption\": {},\n \"disableXPathTransformation\": false\n },\n \"step\": 0,\n \"ruleName\": \"\",\n \"title\": \"\",\n \"prePositionedMarks\": [\n {}\n ],\n \"allowElectronicSignature\": false,\n \"requireSmsAuthenticationToSignElectronically\": false,\n \"requireWhatsappAuthenticationToSignElectronically\": false,\n \"requireAuthenticatorAppToSignElectronically\": false,\n \"requireSelfieAuthenticationToSignElectronically\": false,\n \"requireDatavalidAuthenticationToSignElectronically\": false,\n \"requirePixAuthenticationToSignElectronically\": false,\n \"requireLivenessAuthenticationToSignElectronically\": false,\n \"requireIdScanAuthenticationToSignElectronically\": false,\n \"disableEmailAuthenticationToSignElectronically\": false,\n \"requiredCertificateTypeToSign\": \"A1\",\n \"requireCompanyCertificate\": false,\n \"requiredCompanyIdentifier\": \"\",\n \"requiredCertificateHolderTypeToSign\": \"Individual\",\n \"allowIdrcSignature\": false,\n \"signatureInitialsMode\": \"None\",\n \"notificationLanguage\": \"Pt\"\n }\n ],\n \"observers\": [\n {\n \"user\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"\",\n \"identifierType\": {},\n \"identifier\": \"\",\n \"identifiers\": [],\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"notificationLanguage\": \"Pt\"\n }\n ]\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716130327, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_87fea3f3b3465e33be4192179ba6e2dd", "_type": "request", "parentId": "fld_ideiasigner_flows", "name": "GET document-flows — List created flows", "method": "GET", "url": "{{ _.baseUrl }}/api/document-flows", "description": "**List created flows.**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `Q` | query | string | Query to filter items. |\n| `Limit` | query | integer | Number of items to return. |\n| `Offset` | query | integer | The offset of the searched page (starting with 0). |\n| `Order` | query | Asc/Desc | |\n\nResposta 200: `PaginatedSearchResponse[DocumentFlows.DocumentFlowModel]`\n\n`GET /api/document-flows`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [ { "id": "pair_Q", "name": "Q", "value": "", "description": "Query to filter items.", "disabled": true }, { "id": "pair_Limit", "name": "Limit", "value": "", "description": "Number of items to return.", "disabled": true }, { "id": "pair_Offset", "name": "Offset", "value": "", "description": "The offset of the searched page (starting with 0).", "disabled": true }, { "id": "pair_Order", "name": "Order", "value": "Asc", "description": "", "disabled": true } ], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716130326, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_addab28db19758ba96c93991b7685a44", "_type": "request", "parentId": "fld_ideiasigner_flows", "name": "GET document-flows/{id} — Retrieves flow details", "method": "GET", "url": "{{ _.baseUrl }}/api/document-flows/{{ _.flowId }}", "description": "**Retrieves flow details**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | |\n\nResposta 200: `DocumentFlows.DocumentFlowDetailsModel`\n\n`GET /api/document-flows/{id}`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716130325, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_26715edb46245f77ae62a1ae4af31f09", "_type": "request", "parentId": "fld_ideiasigner_flows", "name": "PUT document-flows/{id} — Updates a flow", "method": "PUT", "url": "{{ _.baseUrl }}/api/document-flows/{{ _.flowId }}", "description": "**Updates a flow.**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | |\n\nBody: `DocumentFlows.DocumentFlowData`\n\n`PUT /api/document-flows/{id}`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"name\": \"\",\n \"areActionsOrdered\": false,\n \"flowActions\": [\n {\n \"user\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"\",\n \"identifierType\": {},\n \"identifier\": \"\",\n \"identifiers\": [],\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"ruleUsers\": [\n {}\n ],\n \"type\": \"Signer\",\n \"numberRequiredActions\": 0,\n \"allowRuleFlowToContinueIfRefused\": false,\n \"xadesOptions\": {\n \"signatureType\": {},\n \"elementToSignIdentifierType\": {},\n \"elementToSignIdentifier\": \"\",\n \"insertionOption\": {},\n \"disableXPathTransformation\": false\n },\n \"step\": 0,\n \"ruleName\": \"\",\n \"title\": \"\",\n \"prePositionedMarks\": [\n {}\n ],\n \"allowElectronicSignature\": false,\n \"requireSmsAuthenticationToSignElectronically\": false,\n \"requireWhatsappAuthenticationToSignElectronically\": false,\n \"requireAuthenticatorAppToSignElectronically\": false,\n \"requireSelfieAuthenticationToSignElectronically\": false,\n \"requireDatavalidAuthenticationToSignElectronically\": false,\n \"requirePixAuthenticationToSignElectronically\": false,\n \"requireLivenessAuthenticationToSignElectronically\": false,\n \"requireIdScanAuthenticationToSignElectronically\": false,\n \"disableEmailAuthenticationToSignElectronically\": false,\n \"requiredCertificateTypeToSign\": \"A1\",\n \"requireCompanyCertificate\": false,\n \"requiredCompanyIdentifier\": \"\",\n \"requiredCertificateHolderTypeToSign\": \"Individual\",\n \"allowIdrcSignature\": false,\n \"signatureInitialsMode\": \"None\",\n \"notificationLanguage\": \"Pt\"\n }\n ],\n \"observers\": [\n {\n \"user\": {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"\",\n \"identifierType\": {},\n \"identifier\": \"\",\n \"identifiers\": [],\n \"email\": \"\",\n \"phone\": \"\"\n },\n \"notificationLanguage\": \"Pt\"\n }\n ]\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716130324, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_690427bbdd325c54b1aec0d6a022b688", "_type": "request", "parentId": "fld_ideiasigner_flows", "name": "DELETE document-flows/{id} — Deletes a flow", "method": "DELETE", "url": "{{ _.baseUrl }}/api/document-flows/{{ _.flowId }}", "description": "**Deletes a flow.**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | |\n\n`DELETE /api/document-flows/{id}`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716130323, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "fld_ideiasigner_folders", "_type": "request_group", "parentId": "wrk_ideiasigner", "name": "5. Pastas", "description": "", "environment": {}, "environmentPropertyOrder": null, "authentication": {}, "metaSortKey": -1790716129327, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_8f155c213ff05244bda4c4569797e544", "_type": "request", "parentId": "fld_ideiasigner_folders", "name": "GET folders — Retrieves all folders paginating the response", "method": "GET", "url": "{{ _.baseUrl }}/api/folders", "description": "**Retrieves all folders paginating the response**\n\nThe Q parameter allows you to filter by folder name.\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `Q` | query | string | Query to filter items. |\n| `Limit` | query | integer | Number of items to return. |\n| `Offset` | query | integer | The offset of the searched page (starting with 0). |\n| `Order` | query | Asc/Desc | |\n| `filterByParent` | query | boolean | if true filters by the parentId parameter |\n| `parentId` | query | string | Id of the parent folder |\n\nResposta 200: `PaginatedSearchResponse[Folders.FolderInfoModel]`\n\n`GET /api/folders`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [ { "id": "pair_Q", "name": "Q", "value": "", "description": "Query to filter items.", "disabled": true }, { "id": "pair_Limit", "name": "Limit", "value": "", "description": "Number of items to return.", "disabled": true }, { "id": "pair_Offset", "name": "Offset", "value": "", "description": "The offset of the searched page (starting with 0).", "disabled": true }, { "id": "pair_Order", "name": "Order", "value": "Asc", "description": "", "disabled": true }, { "id": "pair_filterByParent", "name": "filterByParent", "value": "", "description": "if true filters by the parentId parameter", "disabled": true }, { "id": "pair_parentId", "name": "parentId", "value": "", "description": "Id of the parent folder", "disabled": true } ], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716129327, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_170c4e880fa651dd94f2d60255a9784f", "_type": "request", "parentId": "fld_ideiasigner_folders", "name": "POST folders — Creates a folder", "method": "POST", "url": "{{ _.baseUrl }}/api/folders", "description": "**Creates a folder.**\n\nBody: `Folders.FolderCreateRequest`\n\nResposta 200: `Folders.FolderInfoModel`\n\n`POST /api/folders`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"name\": \"\",\n \"parentId\": \"00000000-0000-0000-0000-000000000000\"\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716129326, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_f86bcad3130e5480aefdacc680e8591a", "_type": "request", "parentId": "fld_ideiasigner_folders", "name": "GET folders/{id} — Retrieves the folder's info", "method": "GET", "url": "{{ _.baseUrl }}/api/folders/{{ _.folderId }}", "description": "**Retrieves the folder's info.**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | Folder id |\n\nResposta 200: `Folders.FolderOrganizationModel`\n\n`GET /api/folders/{id}`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716129325, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_a6951469408d5c93959233a6b326fe09", "_type": "request", "parentId": "fld_ideiasigner_folders", "name": "POST folders/{id}/delete — Deletes a folder", "method": "POST", "url": "{{ _.baseUrl }}/api/folders/{{ _.folderId }}/delete", "description": "**Deletes a folder.**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `id` | path | string | Id of the folder to be deleted |\n\nBody: `Folders.FolderDeleteRequest`\n\n`POST /api/folders/{id}/delete`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"deleteAction\": \"MoveContent\",\n \"destinationFolderId\": \"00000000-0000-0000-0000-000000000000\"\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716129324, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "fld_ideiasigner_contacts", "_type": "request_group", "parentId": "wrk_ideiasigner", "name": "6. Contatos da organização", "description": "", "environment": {}, "environmentPropertyOrder": null, "authentication": {}, "metaSortKey": -1790716128327, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_4db9149db5635fcda6005d48366966f5", "_type": "request", "parentId": "fld_ideiasigner_contacts", "name": "GET organization/contacts — Lists contacts of the organization", "method": "GET", "url": "{{ _.baseUrl }}/api/organization/contacts", "description": "**Lists contacts of the organization.**\n\nThe Q parameter allows filtering by name, email, or identifier.\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `Q` | query | string | Query to filter items. |\n| `Limit` | query | integer | Number of items to return. |\n| `Offset` | query | integer | The offset of the searched page (starting with 0). |\n| `Order` | query | Asc/Desc | |\n\nResposta 200: `PaginatedSearchResponse[Organizations.Contacts.ContactModel]`\n\n`GET /api/organization/contacts`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [ { "id": "pair_Q", "name": "Q", "value": "", "description": "Query to filter items.", "disabled": true }, { "id": "pair_Limit", "name": "Limit", "value": "", "description": "Number of items to return.", "disabled": true }, { "id": "pair_Offset", "name": "Offset", "value": "", "description": "The offset of the searched page (starting with 0).", "disabled": true }, { "id": "pair_Order", "name": "Order", "value": "Asc", "description": "", "disabled": true } ], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716128327, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_7690bd9b6dde5d57943737276daac45e", "_type": "request", "parentId": "fld_ideiasigner_contacts", "name": "POST organization/contacts — Creates a contact in the organization", "method": "POST", "url": "{{ _.baseUrl }}/api/organization/contacts", "description": "**Creates a contact in the organization.**\n\nBody: `Organizations.Contacts.CreateContactRequest`\n\nResposta 200: `Organizations.Contacts.ContactModel`\n\n`POST /api/organization/contacts`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"name\": \"\",\n \"emailAddress\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"Cpf\",\n \"description\": \"\",\n \"phone\": \"\"\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716128326, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_1ef4c8f2df0b5d12be43e50dd21dd6fa", "_type": "request", "parentId": "fld_ideiasigner_contacts", "name": "GET organization/contacts/{contactId} — Retrieves a contact's details", "method": "GET", "url": "{{ _.baseUrl }}/api/organization/contacts/{{ _.contactId }}", "description": "**Retrieves a contact's details.**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `contactId` | path | string | Contact id |\n\nResposta 200: `Organizations.Contacts.ContactModel`\n\n`GET /api/organization/contacts/{contactId}`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716128325, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_6fe1a5281f705de995891fc57128b4e4", "_type": "request", "parentId": "fld_ideiasigner_contacts", "name": "PUT organization/contacts/{contactId} — Updates a contact", "method": "PUT", "url": "{{ _.baseUrl }}/api/organization/contacts/{{ _.contactId }}", "description": "**Updates a contact.**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `contactId` | path | string | Contact id |\n\nBody: `Organizations.Contacts.UpdateContactRequest`\n\nResposta 200: `Organizations.Contacts.ContactModel`\n\n`PUT /api/organization/contacts/{contactId}`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"name\": \"\",\n \"emailAddress\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"Cpf\",\n \"description\": \"\",\n \"phone\": \"\"\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716128324, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_47e9a136832d5271921d28c2641240a8", "_type": "request", "parentId": "fld_ideiasigner_contacts", "name": "DELETE organization/contacts/{contactId} — Deletes a contact", "method": "DELETE", "url": "{{ _.baseUrl }}/api/organization/contacts/{{ _.contactId }}", "description": "**Deletes a contact.**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `contactId` | path | string | Contact id |\n\n`DELETE /api/organization/contacts/{contactId}`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716128323, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_bd95f126602552be9bbd05612d8213da", "_type": "request", "parentId": "fld_ideiasigner_contacts", "name": "POST organization/contacts/batch/create — Creates multiple contacts in the organization", "method": "POST", "url": "{{ _.baseUrl }}/api/organization/contacts/batch/create", "description": "**Creates multiple contacts in the organization.**\n\nProvide either `contacts` (inline list) or `uploadId` (id of a previously uploaded CSV file via POST /api/uploads).\nExpected CSV columns (case-insensitive): name, email, identifier, description.\n\nBody: `Organizations.Contacts.BatchCreateContactsRequest`\n\nResposta 200: `Organizations.Contacts.ContactModel[]`\n\n`POST /api/organization/contacts/batch/create`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"type\": \"Contacts\",\n \"contacts\": [\n {\n \"name\": \"\",\n \"emailAddress\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"Cpf\",\n \"description\": \"\",\n \"phone\": \"\"\n }\n ],\n \"uploadId\": \"\"\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716128322, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_1e28776f0fac5018932d01af665e95cc", "_type": "request", "parentId": "fld_ideiasigner_contacts", "name": "POST organization/contacts/batch/delete — Deletes multiple contacts", "method": "POST", "url": "{{ _.baseUrl }}/api/organization/contacts/batch/delete", "description": "**Deletes multiple contacts.**\n\n`POST /api/organization/contacts/batch/delete`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "[\n \"00000000-0000-0000-0000-000000000000\"\n]" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716128321, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "fld_ideiasigner_organizations", "_type": "request_group", "parentId": "wrk_ideiasigner", "name": "7. Organização e usuários", "description": "", "environment": {}, "environmentPropertyOrder": null, "authentication": {}, "metaSortKey": -1790716127327, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_8c28160f61ee568da59b22f3aef5f9ef", "_type": "request", "parentId": "fld_ideiasigner_organizations", "name": "GET organizations/users — List organization users", "method": "GET", "url": "{{ _.baseUrl }}/api/organizations/users", "description": "**List organization users**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `Q` | query | string | Query to filter items. |\n| `Limit` | query | integer | Number of items to return. |\n| `Offset` | query | integer | The offset of the searched page (starting with 0). |\n| `Order` | query | Asc/Desc | |\n\nResposta 200: `PaginatedSearchResponse[Organizations.OrganizationUserModel]`\n\n`GET /api/organizations/users`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [ { "id": "pair_Q", "name": "Q", "value": "", "description": "Query to filter items.", "disabled": true }, { "id": "pair_Limit", "name": "Limit", "value": "", "description": "Number of items to return.", "disabled": true }, { "id": "pair_Offset", "name": "Offset", "value": "", "description": "The offset of the searched page (starting with 0).", "disabled": true }, { "id": "pair_Order", "name": "Order", "value": "Asc", "description": "", "disabled": true } ], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716127327, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_912699e0ff7e5022bc42428888d77067", "_type": "request", "parentId": "fld_ideiasigner_organizations", "name": "POST organizations/users — Adds a user to the organization", "method": "POST", "url": "{{ _.baseUrl }}/api/organizations/users", "description": "**Adds a user to the organization**\n\nBody: `Organizations.OrganizationUserPostRequest`\n\nResposta 200: `Organizations.OrganizationUserModel`\n\n`POST /api/organizations/users`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"accessProfile\": {\n \"administrator\": false,\n \"manager\": false,\n \"operator\": false\n },\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"name\": \"\",\n \"identifierType\": \"Cpf\",\n \"identifier\": \"\",\n \"identifiers\": [\n {\n \"id\": \"00000000-0000-0000-0000-000000000000\",\n \"isGrant\": false,\n \"type\": \"Cpf\",\n \"value\": \"\"\n }\n ],\n \"email\": \"\",\n \"phone\": \"\"\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716127326, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_babcaedc5c7a520caa4c278571592e7f", "_type": "request", "parentId": "fld_ideiasigner_organizations", "name": "DELETE organizations/users/{userId} — Deletes a user from organization", "method": "DELETE", "url": "{{ _.baseUrl }}/api/organizations/users/{{ _.userId }}", "description": "**Deletes a user from organization**\n\n| Parâmetro | Local | Tipo | Descrição |\n|---|---|---|---|\n| `userId` | path | string | |\n\n`DELETE /api/organizations/users/{userId}`", "headers": [ { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": {}, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716127325, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "fld_ideiasigner_notifications", "_type": "request_group", "parentId": "wrk_ideiasigner", "name": "8. Notificações", "description": "", "environment": {}, "environmentPropertyOrder": null, "authentication": {}, "metaSortKey": -1790716126327, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_588b2a185b0b52928a0251fb44da4db2", "_type": "request", "parentId": "fld_ideiasigner_notifications", "name": "POST notifications/flow-action-reminder — Sends a reminder email to the user of a flow action. (if the action is pending)", "method": "POST", "url": "{{ _.baseUrl }}/api/notifications/flow-action-reminder", "description": "**Sends a reminder email to the user of a flow action. (if the action is pending)**\n\nBody: `Notifications.CreateFlowActionReminderRequest`\n\n`POST /api/notifications/flow-action-reminder`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"documentId\": \"00000000-0000-0000-0000-000000000000\",\n \"flowActionId\": \"00000000-0000-0000-0000-000000000000\"\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716126327, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 }, { "_id": "req_bba21ab653d55e69b0709db969ac7fee", "_type": "request", "parentId": "fld_ideiasigner_notifications", "name": "POST users/notify-pending — Sends a reminder email to the e-mails provided on request. Should be used after creating a batch of documents", "method": "POST", "url": "{{ _.baseUrl }}/api/users/notify-pending", "description": "**Sends a reminder email to the e-mails provided on request. Should be used after creating a batch of documents.**\n\nBody: `Notifications.EmailListNotificationRequest`\n\n`POST /api/users/notify-pending`", "headers": [ { "name": "Content-Type", "value": "application/json" }, { "name": "X-Api-Key", "value": "{{ _.apiKey }}" }, { "name": "Accept", "value": "application/json" } ], "body": { "mimeType": "application/json", "text": "{\n \"emails\": [\n \"\"\n ]\n}" }, "parameters": [], "authentication": {}, "settingStoreCookies": true, "settingSendCookies": true, "settingDisableRenderRequestBody": false, "settingEncodeUrl": true, "settingRebuildPath": true, "settingFollowRedirects": "global", "metaSortKey": -1790716126326, "isPrivate": false, "created": 1790716134327, "modified": 1790716134327 } ] }