{ "item": [ { "name": "1. Autenticação", "description": "Obtenha o token de acesso via OAuth2 client_credentials.", "item": [ { "id": "81a78255-064e-4066-93a0-77b87f6fef6d", "name": "Obter token de acesso", "request": { "name": "Obter token de acesso", "description": { "content": "Emite um token JWT de acesso usando o fluxo OAuth2 `client_credentials`.\nSuporta autenticação via `client_secret` ou via asserção JWT (`private_key_jwt`).\n\nO token retornado deve ser enviado no header `Authorization: Bearer ` nas chamadas protegidas.\n", "type": "text/plain" }, "url": { "path": [ "oauth2", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Tipo de concessão OAuth2.", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "description": { "content": "Identificador do cliente OAuth2 (obrigatório para `client_credentials`).", "type": "text/plain" }, "key": "client_id", "value": "{{client_id}}" }, { "disabled": false, "description": { "content": "Segredo do cliente OAuth2 (obrigatório para `client_credentials` sem `client_assertion`).", "type": "text/plain" }, "key": "client_secret", "value": "{{client_secret}}" }, { "disabled": true, "description": { "content": "Tipo de asserção do cliente (para autenticação via `private_key_jwt`).", "type": "text/plain" }, "key": "client_assertion_type", "value": "urn:ietf:params:oauth:client-assertion-type:jwt-bearer" }, { "disabled": true, "description": { "content": "JWT assinado pelo cliente (para autenticação via `private_key_jwt`).", "type": "text/plain" }, "key": "client_assertion", "value": "" }, { "disabled": true, "description": { "content": "Escopos solicitados, separados por espaço.", "type": "text/plain" }, "key": "scope", "value": "transactions:read transactions:write steps:write evidence:read webhooks:write" } ] }, "auth": null }, "response": [ { "id": "45328a9e-64ad-4f7c-9876-aa1773911695", "name": "Token emitido com sucesso.", "originalRequest": { "url": { "path": [ "oauth2", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Tipo de concessão OAuth2.", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "description": { "content": "Identificador do cliente OAuth2 (obrigatório para `client_credentials`).", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Segredo do cliente OAuth2 (obrigatório para `client_credentials` sem `client_assertion`).", "type": "text/plain" }, "key": "client_secret", "value": "" }, { "disabled": false, "description": { "content": "Tipo de asserção do cliente (para autenticação via `private_key_jwt`).", "type": "text/plain" }, "key": "client_assertion_type", "value": "urn:ietf:params:oauth:client-assertion-type:jwt-bearer" }, { "disabled": false, "description": { "content": "JWT assinado pelo cliente (para autenticação via `private_key_jwt`).", "type": "text/plain" }, "key": "client_assertion", "value": "" }, { "disabled": false, "description": { "content": "Escopos solicitados, separados por espaço.", "type": "text/plain" }, "key": "scope", "value": "" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"access_token\": \"\",\n \"token_type\": \"Bearer\",\n \"expires_in\": \"\",\n \"scope\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33a940d2-1a14-4c6b-b2bb-548130b66aa4", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "oauth2", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Tipo de concessão OAuth2.", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "description": { "content": "Identificador do cliente OAuth2 (obrigatório para `client_credentials`).", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Segredo do cliente OAuth2 (obrigatório para `client_credentials` sem `client_assertion`).", "type": "text/plain" }, "key": "client_secret", "value": "" }, { "disabled": false, "description": { "content": "Tipo de asserção do cliente (para autenticação via `private_key_jwt`).", "type": "text/plain" }, "key": "client_assertion_type", "value": "urn:ietf:params:oauth:client-assertion-type:jwt-bearer" }, { "disabled": false, "description": { "content": "JWT assinado pelo cliente (para autenticação via `private_key_jwt`).", "type": "text/plain" }, "key": "client_assertion", "value": "" }, { "disabled": false, "description": { "content": "Escopos solicitados, separados por espaço.", "type": "text/plain" }, "key": "scope", "value": "" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "298da271-015b-43ae-ba39-52ddbd0db4eb", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "oauth2", "token" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Tipo de concessão OAuth2.", "type": "text/plain" }, "key": "grant_type", "value": "client_credentials" }, { "disabled": false, "description": { "content": "Identificador do cliente OAuth2 (obrigatório para `client_credentials`).", "type": "text/plain" }, "key": "client_id", "value": "" }, { "disabled": false, "description": { "content": "Segredo do cliente OAuth2 (obrigatório para `client_credentials` sem `client_assertion`).", "type": "text/plain" }, "key": "client_secret", "value": "" }, { "disabled": false, "description": { "content": "Tipo de asserção do cliente (para autenticação via `private_key_jwt`).", "type": "text/plain" }, "key": "client_assertion_type", "value": "urn:ietf:params:oauth:client-assertion-type:jwt-bearer" }, { "disabled": false, "description": { "content": "JWT assinado pelo cliente (para autenticação via `private_key_jwt`).", "type": "text/plain" }, "key": "client_assertion", "value": "" }, { "disabled": false, "description": { "content": "Escopos solicitados, separados por espaço.", "type": "text/plain" }, "key": "scope", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "if (pm.response.code === 200) {", " const body = pm.response.json();", " pm.environment.set(\"access_token\", body.access_token);", " pm.test(\"Token obtido com sucesso\", () => {", " pm.expect(body.access_token).to.be.a(\"string\");", " pm.expect(body.token_type).to.eql(\"Bearer\");", " });", "}" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "2. Transações", "description": "Crie, liste, consulte e cancele transações de assinatura.", "item": [ { "id": "49f9b29b-fa1a-4e10-98cb-249eea2defb5", "name": "Criar transação de assinatura", "request": { "name": "Criar transação de assinatura", "description": { "content": "Cria uma nova transação de assinatura eletrônica. Opcionalmente inclui o documento\nem base64 no corpo da requisição. Suporta idempotência via header `X-Idempotency-Key`.\n\nRequer scope `transactions:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"policy\": {\n \"profile\": \"BIOMETRIC\"\n },\n \"signer\": {\n \"name\": \"Maria Silva Santos\",\n \"userExternalId\": \"usr_maria_001\",\n \"email\": \"maria.silva@exemplo.com.br\",\n \"displayName\": \"Maria S.\",\n \"cpf\": \"12345678909\"\n },\n \"metadata\": {\n \"contrato\": \"CTR-2025-0042\",\n \"departamento\": \"Jurídico\"\n },\n \"expiresInMinutes\": 1440\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "04478ff6-50f1-468b-94d9-b7ecd88c6652", "name": "Transação criada com sucesso.", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"CLICK_ONLY\",\n \"customSteps\": [\n \"PURPOSE_DISCLOSURE\",\n \"CLICK_ACCEPT\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"signer\": {\n \"cpf\": true\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"digitalSignature\": {\n \"reason\": \"\",\n \"location\": \"\",\n \"contactInfo\": \"\"\n },\n \"fallbackDocument\": {\n \"image\": \"\",\n \"type\": \"RG\"\n },\n \"documentGroupId\": \"\",\n \"signerIndex\": \"\",\n \"totalSigners\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"expiresInMinutes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "URL do recurso criado.", "type": "text/plain" }, "key": "Location", "value": "" } ], "body": "{\n \"transactionId\": \"\",\n \"status\": \"CREATED\",\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"policy\": {\n \"profile\": \"DIGITAL_CERTIFICATE\",\n \"customSteps\": [\n \"PURPOSE_DISCLOSURE\",\n \"SERPRO_IDENTITY_CHECK\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"steps\": [\n {\n \"stepId\": \"\",\n \"type\": \"DOCUMENT_PHOTO_MATCH\",\n \"status\": \"SKIPPED\",\n \"order\": \"\"\n },\n {\n \"stepId\": \"\",\n \"type\": \"BIOMETRIC_MATCH\",\n \"status\": \"COMPLETED\",\n \"order\": \"\"\n }\n ],\n \"userExternalId\": \"\",\n \"createdAt\": \"\",\n \"documentHash\": \"\",\n \"expiresAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "005dc49b-3877-49c6-a4bc-d73710a6241b", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"CLICK_ONLY\",\n \"customSteps\": [\n \"PURPOSE_DISCLOSURE\",\n \"CLICK_ACCEPT\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"signer\": {\n \"cpf\": true\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"digitalSignature\": {\n \"reason\": \"\",\n \"location\": \"\",\n \"contactInfo\": \"\"\n },\n \"fallbackDocument\": {\n \"image\": \"\",\n \"type\": \"RG\"\n },\n \"documentGroupId\": \"\",\n \"signerIndex\": \"\",\n \"totalSigners\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"expiresInMinutes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "093484c3-68de-43e2-8399-5e58d9b42739", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"CLICK_ONLY\",\n \"customSteps\": [\n \"PURPOSE_DISCLOSURE\",\n \"CLICK_ACCEPT\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"signer\": {\n \"cpf\": true\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"digitalSignature\": {\n \"reason\": \"\",\n \"location\": \"\",\n \"contactInfo\": \"\"\n },\n \"fallbackDocument\": {\n \"image\": \"\",\n \"type\": \"RG\"\n },\n \"documentGroupId\": \"\",\n \"signerIndex\": \"\",\n \"totalSigners\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"expiresInMinutes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "90ac2729-7919-4f56-85e1-660fe70054f7", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"CLICK_ONLY\",\n \"customSteps\": [\n \"PURPOSE_DISCLOSURE\",\n \"CLICK_ACCEPT\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"signer\": {\n \"cpf\": true\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"digitalSignature\": {\n \"reason\": \"\",\n \"location\": \"\",\n \"contactInfo\": \"\"\n },\n \"fallbackDocument\": {\n \"image\": \"\",\n \"type\": \"RG\"\n },\n \"documentGroupId\": \"\",\n \"signerIndex\": \"\",\n \"totalSigners\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"expiresInMinutes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a9fb873-4fdd-4a6d-b72d-b849ec88dd94", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"CLICK_ONLY\",\n \"customSteps\": [\n \"PURPOSE_DISCLOSURE\",\n \"CLICK_ACCEPT\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"signer\": {\n \"cpf\": true\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"digitalSignature\": {\n \"reason\": \"\",\n \"location\": \"\",\n \"contactInfo\": \"\"\n },\n \"fallbackDocument\": {\n \"image\": \"\",\n \"type\": \"RG\"\n },\n \"documentGroupId\": \"\",\n \"signerIndex\": \"\",\n \"totalSigners\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"expiresInMinutes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8eb9761-9d34-4491-a7ba-6f0704190569", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.\n\nInclui o perfil de política não autorizado para o tenant. As rotas de criação\n(`/v1/transactions`, `/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`)\nverificam a mesma regra, antes de cota, convite e gravação — a recusa não consome\ndocumento. As flags envolvidas são `featureFlags.customPolicyEnabled` (perfil `CUSTOM`),\n`serpro.enabled` (perfis SERPRO), `featureFlags.documentExtractionEnabled` (fallback por\ndocumento; `BIOMETRIC_SERPRO_AUTO_FALLBACK` exige as duas últimas) e\n`featureFlags.biometricRequired`. O remédio é habilitar a flag para o tenant.\n\n`signer.cpf` e `signer.birthDate`, exigidos pelos perfis SERPRO, são validados como\n**400** e não aqui: requisição malformada, corrigível na mesma chamada.", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"CLICK_ONLY\",\n \"customSteps\": [\n \"PURPOSE_DISCLOSURE\",\n \"CLICK_ACCEPT\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"signer\": {\n \"cpf\": true\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"digitalSignature\": {\n \"reason\": \"\",\n \"location\": \"\",\n \"contactInfo\": \"\"\n },\n \"fallbackDocument\": {\n \"image\": \"\",\n \"type\": \"RG\"\n },\n \"documentGroupId\": \"\",\n \"signerIndex\": \"\",\n \"totalSigners\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"expiresInMinutes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dbccab4a-3393-44e6-962c-1b559779f56f", "name": "Limite de requisições excedido.", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"CLICK_ONLY\",\n \"customSteps\": [\n \"PURPOSE_DISCLOSURE\",\n \"CLICK_ACCEPT\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"signer\": {\n \"cpf\": true\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"digitalSignature\": {\n \"reason\": \"\",\n \"location\": \"\",\n \"contactInfo\": \"\"\n },\n \"fallbackDocument\": {\n \"image\": \"\",\n \"type\": \"RG\"\n },\n \"documentGroupId\": \"\",\n \"signerIndex\": \"\",\n \"totalSigners\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"expiresInMinutes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de tentar novamente.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bc81d63-ff4b-436b-8185-eb00ca469402", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"CLICK_ONLY\",\n \"customSteps\": [\n \"PURPOSE_DISCLOSURE\",\n \"CLICK_ACCEPT\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"signer\": {\n \"cpf\": true\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"digitalSignature\": {\n \"reason\": \"\",\n \"location\": \"\",\n \"contactInfo\": \"\"\n },\n \"fallbackDocument\": {\n \"image\": \"\",\n \"type\": \"RG\"\n },\n \"documentGroupId\": \"\",\n \"signerIndex\": \"\",\n \"totalSigners\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"expiresInMinutes\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "if (pm.response.code === 201) {", " const body = pm.response.json();", " pm.environment.set(\"transactionId\", body.transactionId);", " pm.test(\"Transação criada\", () => {", " pm.expect(body.transactionId).to.be.a(\"string\");", " pm.expect(body.status).to.eql(\"PENDING\");", " });", "}" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f8db47f0-6611-41e0-8829-69f0505be8e8", "name": "Listar transações", "request": { "name": "Listar transações", "description": { "content": "Retorna uma lista paginada de transações do tenant autenticado.\nSuporta filtros por status, usuário, grupo de documentos e intervalo de datas.\n\nRequer scope `transactions:read`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filtrar por status da transação. (This can only be one of CREATED,DOCUMENT_UPLOADED,IN_PROGRESS,COMPLETED,CANCELLED,EXPIRED,FAILED)", "type": "text/plain" }, "key": "status", "value": "COMPLETED" }, { "disabled": false, "description": { "content": "Filtrar por identificador externo do usuário.", "type": "text/plain" }, "key": "userExternalId", "value": "" }, { "disabled": false, "description": { "content": "Filtrar por grupo de documentos.", "type": "text/plain" }, "key": "documentGroupId", "value": "" }, { "disabled": false, "description": { "content": "Data inicial do intervalo (ISO 8601).", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Data final do intervalo (ISO 8601).", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Número máximo de resultados por página (máximo 100).", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "Token de paginação retornado pela consulta anterior.", "type": "text/plain" }, "key": "nextToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "4b009380-05f3-4afa-a0ef-2d948d3ad665", "name": "Lista de transações retornada com sucesso.", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filtrar por status da transação. (This can only be one of CREATED,DOCUMENT_UPLOADED,IN_PROGRESS,COMPLETED,CANCELLED,EXPIRED,FAILED)", "type": "text/plain" }, "key": "status", "value": "COMPLETED" }, { "disabled": false, "description": { "content": "Filtrar por identificador externo do usuário.", "type": "text/plain" }, "key": "userExternalId", "value": "" }, { "disabled": false, "description": { "content": "Filtrar por grupo de documentos.", "type": "text/plain" }, "key": "documentGroupId", "value": "" }, { "disabled": false, "description": { "content": "Data inicial do intervalo (ISO 8601).", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Data final do intervalo (ISO 8601).", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Número máximo de resultados por página (máximo 100).", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "Token de paginação retornado pela consulta anterior.", "type": "text/plain" }, "key": "nextToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"transactions\": [\n {\n \"transactionId\": \"\",\n \"status\": \"FAILED\",\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"policy\": {\n \"profile\": \"DIGITAL_CERTIFICATE\",\n \"customSteps\": [\n \"SERPRO_IDENTITY_CHECK\",\n \"SERPRO_IDENTITY_CHECK\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"userExternalId\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"documentHash\": \"\",\n \"documentGroupId\": \"\"\n },\n {\n \"transactionId\": \"\",\n \"status\": \"CREATED\",\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"policy\": {\n \"profile\": \"BIOMETRIC_PLUS_OTP\",\n \"customSteps\": [\n \"OTP_CHALLENGE\",\n \"SERPRO_IDENTITY_CHECK\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"userExternalId\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"documentHash\": \"\",\n \"documentGroupId\": \"\"\n }\n ],\n \"count\": \"\",\n \"nextToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8413353-b87a-468a-b9b4-6d726282c1e7", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filtrar por status da transação. (This can only be one of CREATED,DOCUMENT_UPLOADED,IN_PROGRESS,COMPLETED,CANCELLED,EXPIRED,FAILED)", "type": "text/plain" }, "key": "status", "value": "COMPLETED" }, { "disabled": false, "description": { "content": "Filtrar por identificador externo do usuário.", "type": "text/plain" }, "key": "userExternalId", "value": "" }, { "disabled": false, "description": { "content": "Filtrar por grupo de documentos.", "type": "text/plain" }, "key": "documentGroupId", "value": "" }, { "disabled": false, "description": { "content": "Data inicial do intervalo (ISO 8601).", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Data final do intervalo (ISO 8601).", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Número máximo de resultados por página (máximo 100).", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "Token de paginação retornado pela consulta anterior.", "type": "text/plain" }, "key": "nextToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b49d7c2b-9e78-437b-9af9-9256f572365c", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filtrar por status da transação. (This can only be one of CREATED,DOCUMENT_UPLOADED,IN_PROGRESS,COMPLETED,CANCELLED,EXPIRED,FAILED)", "type": "text/plain" }, "key": "status", "value": "COMPLETED" }, { "disabled": false, "description": { "content": "Filtrar por identificador externo do usuário.", "type": "text/plain" }, "key": "userExternalId", "value": "" }, { "disabled": false, "description": { "content": "Filtrar por grupo de documentos.", "type": "text/plain" }, "key": "documentGroupId", "value": "" }, { "disabled": false, "description": { "content": "Data inicial do intervalo (ISO 8601).", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Data final do intervalo (ISO 8601).", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Número máximo de resultados por página (máximo 100).", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "Token de paginação retornado pela consulta anterior.", "type": "text/plain" }, "key": "nextToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd5531a5-3b55-4a53-8724-3e0be275e3bc", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filtrar por status da transação. (This can only be one of CREATED,DOCUMENT_UPLOADED,IN_PROGRESS,COMPLETED,CANCELLED,EXPIRED,FAILED)", "type": "text/plain" }, "key": "status", "value": "COMPLETED" }, { "disabled": false, "description": { "content": "Filtrar por identificador externo do usuário.", "type": "text/plain" }, "key": "userExternalId", "value": "" }, { "disabled": false, "description": { "content": "Filtrar por grupo de documentos.", "type": "text/plain" }, "key": "documentGroupId", "value": "" }, { "disabled": false, "description": { "content": "Data inicial do intervalo (ISO 8601).", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Data final do intervalo (ISO 8601).", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Número máximo de resultados por página (máximo 100).", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "Token de paginação retornado pela consulta anterior.", "type": "text/plain" }, "key": "nextToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69c3c655-e2b1-4c7b-88df-85c401464cc7", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filtrar por status da transação. (This can only be one of CREATED,DOCUMENT_UPLOADED,IN_PROGRESS,COMPLETED,CANCELLED,EXPIRED,FAILED)", "type": "text/plain" }, "key": "status", "value": "COMPLETED" }, { "disabled": false, "description": { "content": "Filtrar por identificador externo do usuário.", "type": "text/plain" }, "key": "userExternalId", "value": "" }, { "disabled": false, "description": { "content": "Filtrar por grupo de documentos.", "type": "text/plain" }, "key": "documentGroupId", "value": "" }, { "disabled": false, "description": { "content": "Data inicial do intervalo (ISO 8601).", "type": "text/plain" }, "key": "startDate", "value": "" }, { "disabled": false, "description": { "content": "Data final do intervalo (ISO 8601).", "type": "text/plain" }, "key": "endDate", "value": "" }, { "disabled": false, "description": { "content": "Número máximo de resultados por página (máximo 100).", "type": "text/plain" }, "key": "limit", "value": "25" }, { "disabled": false, "description": { "content": "Token de paginação retornado pela consulta anterior.", "type": "text/plain" }, "key": "nextToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ab893294-99c0-44a0-99fd-1fc3e212954e", "name": "Consultar transação", "request": { "name": "Consultar transação", "description": { "content": "Retorna os detalhes completos de uma transação, incluindo signatário, etapas e metadados.\n\nRequer scope `transactions:read`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "e351db50-8f0c-4724-b56e-a4fd5ff87585", "name": "Detalhes da transação retornados com sucesso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"transactionId\": \"\",\n \"status\": \"DOCUMENT_UPLOADED\",\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"BIOMETRIC\",\n \"customSteps\": [\n \"SERPRO_IDENTITY_CHECK\",\n \"OTP_VERIFY\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"userExternalId\": \"\",\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"steps\": [\n {\n \"stepId\": \"\",\n \"type\": \"OTP_VERIFY\",\n \"status\": \"FAILED\",\n \"order\": \"\",\n \"attempts\": \"\",\n \"startedAt\": \"\",\n \"completedAt\": \"\"\n },\n {\n \"stepId\": \"\",\n \"type\": \"BIOMETRIC_MATCH\",\n \"status\": \"PENDING\",\n \"order\": \"\",\n \"attempts\": \"\",\n \"startedAt\": \"\",\n \"completedAt\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"documentHash\": \"\",\n \"documentGroupId\": \"\",\n \"signerIndex\": \"\",\n \"totalSigners\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"expiresAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee49bf3c-8b85-4256-bda7-0bd1c0cdfe47", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a5e0492-149d-4906-a70f-689fddc76d46", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6542b99a-abdb-4f21-888b-998f0222e6af", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "396c2849-234c-42cf-a9b8-67a70169d84c", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3556e937-ae21-4081-b247-05da8ffa5876", "name": "Cancelar transação", "request": { "name": "Cancelar transação", "description": { "content": "Cancela uma transação em andamento. Apenas transações que ainda não foram\nfinalizadas podem ser canceladas.\n\nRequer scope `transactions:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "d7d430e3-d478-4ccc-9cc0-db0a10e1b65a", "name": "Transação cancelada com sucesso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"transactionId\": \"\",\n \"status\": \"CANCELLED\",\n \"cancelledAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96b5f56a-2842-4159-bb95-440fef6870d3", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60623452-a527-458a-b682-8eee86394569", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00a1ebb6-8948-4338-80c0-d8491a050634", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2aebd27c-1adc-47fc-9d55-1a031df18a76", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "453b6d14-82f6-4dc5-ae5f-4a7cecd9d3a7", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "3. Documentos", "description": "Upload, pré-assinatura e download de documentos da transação.", "item": [ { "id": "83b262d9-7f73-4fa7-9289-8cb2a2a883b0", "name": "Upload de documento (base64)", "request": { "name": "Upload de documento (base64)", "description": { "content": "Envia o documento codificado em base64 diretamente no corpo da requisição. Suporta PDF, DOCX, XLSX, PPTX, ODT, imagens e outros formatos.\nPara documentos maiores, utilize o fluxo de upload pré-assinado\n(`presign` → upload direto ao S3 → `confirm`).\n\n### Validação de qualidade do PDF\n\nO documento é validado quanto à qualidade e integridade. Caso o PDF seja inválido,\ncorrompido, protegido por senha ou não atenda aos critérios mínimos de qualidade,\na API retorna `422 Unprocessable Entity` com detalhes do problema.\n\nRequer scope `transactions:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "transactions", ":transactionId", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"JVBERi0xLjQK... (substitua pelo conteúdo base64 do PDF)\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "9b27c050-a518-4202-a2f4-ee0a3e352575", "name": "Documento enviado com sucesso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"transactionId\": \"\",\n \"documentHash\": \"\",\n \"status\": \"DOCUMENT_UPLOADED\",\n \"uploadedAt\": \"\",\n \"documentFormat\": \"generic\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dac970e-b612-46b8-b4b2-5e28ac1bfdf9", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d3c4aa9-5ce4-4c7b-b712-4492e008e43e", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "733dba9c-4f95-4cf6-901f-9e90bb7a31b2", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42e22ff2-d127-4a71-b510-9959318285bd", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6729834e-3d2a-4661-a583-f4f76c33c3dd", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66c826a0-2e83-44c8-a6e8-f8619be49836", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.\n\nInclui o perfil de política não autorizado para o tenant. As rotas de criação\n(`/v1/transactions`, `/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`)\nverificam a mesma regra, antes de cota, convite e gravação — a recusa não consome\ndocumento. As flags envolvidas são `featureFlags.customPolicyEnabled` (perfil `CUSTOM`),\n`serpro.enabled` (perfis SERPRO), `featureFlags.documentExtractionEnabled` (fallback por\ndocumento; `BIOMETRIC_SERPRO_AUTO_FALLBACK` exige as duas últimas) e\n`featureFlags.biometricRequired`. O remédio é habilitar a flag para o tenant.\n\n`signer.cpf` e `signer.birthDate`, exigidos pelos perfis SERPRO, são validados como\n**400** e não aqui: requisição malformada, corrigível na mesma chamada.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bbf1b736-383a-43a7-afd8-3a18934d843d", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "30c91ccd-f47d-472a-ad04-095bce06e239", "name": "Obter URL pré-assinada para upload", "request": { "name": "Obter URL pré-assinada para upload", "description": { "content": "Gera uma URL pré-assinada do S3 para upload direto do documento.\nApós o upload, confirme com `POST /v1/transactions/{id}/document/confirm`.\n\nRecomendado para documentos maiores que 5 MB.\n\nRequer scope `transactions:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "transactions", ":transactionId", "document", "presign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"filename\": \"contrato-locacao-2025.pdf\",\n \"contentType\": \"application/pdf\",\n \"contentLength\": 245760\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "45ed421e-4f2b-4ac7-a0e0-7ec72ba3c861", "name": "URL pré-assinada gerada com sucesso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document", "presign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentType\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"uploadUrl\": \"\",\n \"uploadToken\": \"\",\n \"s3Key\": \"\",\n \"expiresIn\": \"\",\n \"contentType\": \"\",\n \"instructions\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "529b25f8-e3d4-4b3a-8bfd-bda87a165922", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document", "presign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentType\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "20046145-562d-4b95-9d27-3f81a37e295d", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document", "presign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentType\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "263a19cb-0229-46f4-9226-777c4207730d", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document", "presign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentType\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30b43adc-fc21-4129-bcd6-e2b4397c2514", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document", "presign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentType\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f36b4ae-a401-4404-b77e-4b85d0e2b1af", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document", "presign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentType\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7cc6cc9-6ed5-46fe-a480-d2222d51b086", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document", "presign" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contentType\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "93738358-ab1a-42de-b966-fe41fcc47e53", "name": "Confirmar upload pré-assinado", "request": { "name": "Confirmar upload pré-assinado", "description": { "content": "Confirma que o upload via URL pré-assinada foi concluído com sucesso.\nO `uploadToken` foi retornado na resposta de `presign`.\n\nApós a confirmação, o documento é validado quanto à qualidade e integridade (validação de qualidade aplica-se apenas a PDFs). Caso não\natenda aos critérios mínimos, retorna `422 Unprocessable Entity` com detalhes do problema.\n\nRequer scope `transactions:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "transactions", ":transactionId", "document", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uploadToken\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "da824e33-64e6-4177-b95a-4f7ebdf9536e", "name": "Upload confirmado com sucesso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uploadToken\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"transactionId\": \"\",\n \"status\": \"DOCUMENT_UPLOADED\",\n \"documentHash\": \"\",\n \"documentFormat\": \"generic\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e6c7096-9b5b-49d8-8087-d9c20a9abaa0", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uploadToken\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38c6d7d5-08e2-4cbd-ac8e-c1e861b29b1c", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uploadToken\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d16b479-d4f5-4e36-8de6-ce2976b18745", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uploadToken\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f73b813-24e2-479f-9878-4367504dd37c", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uploadToken\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "105256f5-74b2-4198-8ff7-5e1047c743fe", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uploadToken\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98933c76-ce9b-45c5-8210-5e02d466818c", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.\n\nInclui o perfil de política não autorizado para o tenant. As rotas de criação\n(`/v1/transactions`, `/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`)\nverificam a mesma regra, antes de cota, convite e gravação — a recusa não consome\ndocumento. As flags envolvidas são `featureFlags.customPolicyEnabled` (perfil `CUSTOM`),\n`serpro.enabled` (perfis SERPRO), `featureFlags.documentExtractionEnabled` (fallback por\ndocumento; `BIOMETRIC_SERPRO_AUTO_FALLBACK` exige as duas últimas) e\n`featureFlags.biometricRequired`. O remédio é habilitar a flag para o tenant.\n\n`signer.cpf` e `signer.birthDate`, exigidos pelos perfis SERPRO, são validados como\n**400** e não aqui: requisição malformada, corrigível na mesma chamada.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uploadToken\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eddd4d40-e997-4ee3-a680-9eb8a9d7265e", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uploadToken\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3488c9a6-26f9-48a8-9297-a5b7af7aaeda", "name": "Obter URLs de download do documento", "request": { "name": "Obter URLs de download do documento", "description": { "content": "Retorna URLs pré-assinadas para download do documento original e do documento assinado.\nAs URLs expiram em 1 hora.\n\nRequer scope `transactions:read`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "transactions", ":transactionId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "2452fa20-cd38-47c8-ace8-90124bbdb356", "name": "URLs de download geradas com sucesso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"transactionId\": \"\",\n \"expiresIn\": \"\",\n \"documentHash\": \"\",\n \"documentFormat\": \"pdf\",\n \"originalUrl\": \"\",\n \"signedUrl\": \"\",\n \"signatureUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5da73bbf-e56d-4852-899d-5d5d3c1839e2", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ec83ecc-1036-40c7-a97b-31d46aa3229d", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d563055-5b45-4d56-8303-6d90104ba7b2", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a93157f6-b9cb-4413-9668-f03b3593b919", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "download" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "4. Etapas", "description": "Liste, inicie e conclua as etapas de verificação (OTP, biometria, clickwrap).", "item": [ { "id": "67945c42-52e9-433a-aa7a-4bff962273e9", "name": "Listar etapas da transação", "request": { "name": "Listar etapas da transação", "description": { "content": "Retorna todas as etapas de verificação de identidade vinculadas à transação,\ncom seus status, tentativas e resultados.\n\nRequer scope `steps:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "transactions", ":transactionId", "steps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "84a019d9-e406-4b45-a894-4a9441cc5762", "name": "Lista de etapas retornada com sucesso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"steps\": [\n {\n \"stepId\": \"\",\n \"type\": \"OTP_VERIFY\",\n \"status\": \"DORMANT\",\n \"order\": \"\",\n \"attempts\": \"\",\n \"maxAttempts\": \"\",\n \"captureMode\": \"HOSTED_PAGE\",\n \"startedAt\": \"\",\n \"completedAt\": \"\",\n \"error\": \"\"\n },\n {\n \"stepId\": \"\",\n \"type\": \"SERPRO_IDENTITY_CHECK\",\n \"status\": \"COMPLETED\",\n \"order\": \"\",\n \"attempts\": \"\",\n \"maxAttempts\": \"\",\n \"captureMode\": \"HOSTED_PAGE\",\n \"startedAt\": \"\",\n \"completedAt\": \"\",\n \"error\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68dc89f2-018a-47a8-bea2-15fa3139984f", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ac073ba-9573-436c-828b-10331e9e78d4", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c50be62-c725-4541-8330-710f3ee9842b", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9418196-36b3-4e43-aaa2-ffb6e82ec834", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "if (pm.response.code === 200) {", " const body = pm.response.json();", " if (body.steps && body.steps.length > 0) {", " const firstPending = body.steps.find(s => s.status === \"PENDING\") || body.steps[0];", " pm.environment.set(\"stepId\", firstPending.stepId);", " pm.test(\"stepId extraído\", () => {", " pm.expect(firstPending.stepId).to.be.a(\"string\");", " });", " }", "}" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "adaa95d9-a476-4787-a6c7-e80dae6c6eb5", "name": "Iniciar etapa de verificação", "request": { "name": "Iniciar etapa de verificação", "description": "Inicia uma etapa de verificação de identidade.\n\n**Reenvio de OTP**: Ao chamar `start` novamente em uma etapa `OTP_CHALLENGE` (attempt > 1), um novo código OTP é enviado e a etapa `OTP_VERIFY` pareada é automaticamente resetada se estava em status `FAILED` ou `STARTED`.", "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "start" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "stepId", "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"captureMode\": \"BANK_APP\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "3b554bb8-0ed1-4e07-a707-dfa461b4c294", "name": "Etapa iniciada com sucesso. A resposta varia conforme o tipo.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "start" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"captureMode\": \"BANK_APP\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"stepId\": \"\",\n \"type\": \"CLICK_ACCEPT\",\n \"status\": \"DORMANT\",\n \"livenessSessionId\": \"\",\n \"hostedUrl\": \"\",\n \"message\": \"\",\n \"otpCode\": \"\",\n \"channel\": \"email\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "093294dc-7d18-4e82-8d46-8496b3440f13", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "start" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"captureMode\": \"BANK_APP\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f652303-edb7-4760-bdd8-b4a8f12137b6", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "start" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"captureMode\": \"BANK_APP\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcd049c6-d42c-4c88-814c-82f4fef0ccdd", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "start" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"captureMode\": \"BANK_APP\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d9413b7-e664-4402-a1e0-4f948b8f55cb", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "start" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"captureMode\": \"BANK_APP\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67137eb4-87da-4c4d-8396-f765b4ca6ec2", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "start" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"captureMode\": \"BANK_APP\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9192d6d3-33a4-4991-bad1-76b7f5ef341f", "name": "Limite de requisições excedido.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "start" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"captureMode\": \"BANK_APP\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de tentar novamente.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bec124c-83b4-41a4-b16d-c173f70418dd", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "start" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"captureMode\": \"BANK_APP\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bca78d76-4cad-414a-9a75-30af2aa2fc8b", "name": "Serviço temporariamente indisponível.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "start" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"captureMode\": \"BANK_APP\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de tentar novamente.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c9ed8edd-b48e-40df-a3a7-179925d6be1b", "name": "Concluir etapa de verificação", "request": { "name": "Concluir etapa de verificação", "description": "Conclui uma etapa de verificação. O corpo varia conforme o tipo:\n\n**OTP_VERIFY** (padrão deste exemplo):\n```json\n{ \"code\": \"123456\" }\n```\n\n**BIOMETRIC_LIVENESS / BIOMETRIC_MATCH**:\n```json\n{ \"livenessSessionId\": \"session-abc-123\" }\n```\n\n**CLICK_ACCEPT**:\n```json\n{ \"accepted\": true }\n```\n\n**DOCUMENT_PHOTO_MATCH** (extração facial de documento):\n```json\n{\n \"documentImage\": \"\",\n \"documentType\": \"CNH\",\n \"geolocation\": { \"latitude\": -23.5505, \"longitude\": -46.6333 }\n}\n```\n\n**SERPRO_IDENTITY_CHECK** (verificação via SERPRO DataValid):\n```json\n{\n \"cpf\": \"12345678901\",\n \"name\": \"Maria Silva Santos\",\n \"birthDate\": \"1990-01-15\"\n}\n```\n\n> **Nota**: O campo `geolocation` é obrigatório para etapas biométricas quando o tenant possui `biometricRequired` habilitado.", "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "stepId", "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"123456\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "82351c52-7244-4a4d-987c-ac59d4382545", "name": "Etapa concluída (ou falhou). Verifique o campo `status` na resposta.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"livenessSessionId\": \"\",\n \"referenceImage\": {\n \"source\": \"BASE64_IMAGE\",\n \"data\": \"\"\n },\n \"sandboxBrightness\": \"\",\n \"sandboxSharpness\": \"\",\n \"sandboxLivenessConfidence\": \"\",\n \"sandboxSimilarity\": \"\",\n \"code\": \"\",\n \"accepted\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"OTHER\",\n \"cpf\": \"80323856505\",\n \"name\": \"\",\n \"birthDate\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"stepId\": \"\",\n \"type\": \"DIGITAL_SIGN_A1\",\n \"status\": \"FAILED\",\n \"attempts\": \"\",\n \"result\": {\n \"liveness\": {\n \"confidence\": \"\",\n \"provider\": \"\",\n \"captureMode\": \"BANK_APP\"\n },\n \"match\": {\n \"similarity\": \"\",\n \"threshold\": \"\"\n },\n \"otp\": {\n \"verified\": \"\",\n \"channel\": \"email\"\n },\n \"click\": {\n \"accepted\": \"\",\n \"textVersion\": \"\"\n },\n \"digitalSignature\": {\n \"certificateSubject\": \"\",\n \"certificateSerial\": \"\",\n \"certificateIssuer\": \"\",\n \"algorithm\": \"\",\n \"signedAt\": \"\",\n \"signedPdfHash\": \"\",\n \"signedPdfS3Key\": \"\",\n \"signatureFieldName\": \"\",\n \"signatureTimestamp\": {\n \"genTime\": \"\",\n \"tsaName\": \"\",\n \"serial\": \"\",\n \"policyOid\": \"\",\n \"tokenSha256\": \"\"\n }\n },\n \"documentPhotoMatch\": {\n \"similarity\": \"\",\n \"documentType\": \"CNH\",\n \"extractionConfidence\": \"\"\n },\n \"serproIdentityCheck\": {\n \"verified\": \"\",\n \"cpfMatch\": \"\",\n \"nameMatch\": \"\",\n \"birthDateMatch\": \"\",\n \"governmentDatabase\": \"SERPRO_DATAVALID\"\n },\n \"governmentDbValidation\": {\n \"database\": \"SERPRO_DATAVALID\",\n \"validatedAt\": \"\",\n \"cpfHash\": \"\",\n \"biometricScore\": \"\",\n \"cached\": \"\",\n \"cacheVerifySimilarity\": \"\"\n },\n \"enrollmentRef\": {\n \"source\": \"ENROLLMENT\",\n \"capturedFrom\": \"ORGANIZATION_PROVIDED\",\n \"enrolledAt\": \"\",\n \"enrollmentHash\": \"\",\n \"version\": \"\",\n \"imageHash\": \"\"\n },\n \"providerTimestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7477198a-d126-4dbf-b7ce-993313a82ba4", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"livenessSessionId\": \"\",\n \"referenceImage\": {\n \"source\": \"BASE64_IMAGE\",\n \"data\": \"\"\n },\n \"sandboxBrightness\": \"\",\n \"sandboxSharpness\": \"\",\n \"sandboxLivenessConfidence\": \"\",\n \"sandboxSimilarity\": \"\",\n \"code\": \"\",\n \"accepted\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"OTHER\",\n \"cpf\": \"80323856505\",\n \"name\": \"\",\n \"birthDate\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f34b004-59bb-4202-b928-51d4b2677b57", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"livenessSessionId\": \"\",\n \"referenceImage\": {\n \"source\": \"BASE64_IMAGE\",\n \"data\": \"\"\n },\n \"sandboxBrightness\": \"\",\n \"sandboxSharpness\": \"\",\n \"sandboxLivenessConfidence\": \"\",\n \"sandboxSimilarity\": \"\",\n \"code\": \"\",\n \"accepted\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"OTHER\",\n \"cpf\": \"80323856505\",\n \"name\": \"\",\n \"birthDate\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "424ed206-0bc7-4ca1-81bd-513b0eae417e", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"livenessSessionId\": \"\",\n \"referenceImage\": {\n \"source\": \"BASE64_IMAGE\",\n \"data\": \"\"\n },\n \"sandboxBrightness\": \"\",\n \"sandboxSharpness\": \"\",\n \"sandboxLivenessConfidence\": \"\",\n \"sandboxSimilarity\": \"\",\n \"code\": \"\",\n \"accepted\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"OTHER\",\n \"cpf\": \"80323856505\",\n \"name\": \"\",\n \"birthDate\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de0b7642-c980-402a-b74b-a7ca81002015", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"livenessSessionId\": \"\",\n \"referenceImage\": {\n \"source\": \"BASE64_IMAGE\",\n \"data\": \"\"\n },\n \"sandboxBrightness\": \"\",\n \"sandboxSharpness\": \"\",\n \"sandboxLivenessConfidence\": \"\",\n \"sandboxSimilarity\": \"\",\n \"code\": \"\",\n \"accepted\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"OTHER\",\n \"cpf\": \"80323856505\",\n \"name\": \"\",\n \"birthDate\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55e42f46-3146-47d6-a5dd-de718ceec383", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"livenessSessionId\": \"\",\n \"referenceImage\": {\n \"source\": \"BASE64_IMAGE\",\n \"data\": \"\"\n },\n \"sandboxBrightness\": \"\",\n \"sandboxSharpness\": \"\",\n \"sandboxLivenessConfidence\": \"\",\n \"sandboxSimilarity\": \"\",\n \"code\": \"\",\n \"accepted\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"OTHER\",\n \"cpf\": \"80323856505\",\n \"name\": \"\",\n \"birthDate\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c6e64c02-0148-48c8-a746-d1f76a22c43f", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.\n\nInclui o perfil de política não autorizado para o tenant. As rotas de criação\n(`/v1/transactions`, `/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`)\nverificam a mesma regra, antes de cota, convite e gravação — a recusa não consome\ndocumento. As flags envolvidas são `featureFlags.customPolicyEnabled` (perfil `CUSTOM`),\n`serpro.enabled` (perfis SERPRO), `featureFlags.documentExtractionEnabled` (fallback por\ndocumento; `BIOMETRIC_SERPRO_AUTO_FALLBACK` exige as duas últimas) e\n`featureFlags.biometricRequired`. O remédio é habilitar a flag para o tenant.\n\n`signer.cpf` e `signer.birthDate`, exigidos pelos perfis SERPRO, são validados como\n**400** e não aqui: requisição malformada, corrigível na mesma chamada.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"livenessSessionId\": \"\",\n \"referenceImage\": {\n \"source\": \"BASE64_IMAGE\",\n \"data\": \"\"\n },\n \"sandboxBrightness\": \"\",\n \"sandboxSharpness\": \"\",\n \"sandboxLivenessConfidence\": \"\",\n \"sandboxSimilarity\": \"\",\n \"code\": \"\",\n \"accepted\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"OTHER\",\n \"cpf\": \"80323856505\",\n \"name\": \"\",\n \"birthDate\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3331d8d-ad0b-4a19-92f8-a9a7746b6ac6", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"livenessSessionId\": \"\",\n \"referenceImage\": {\n \"source\": \"BASE64_IMAGE\",\n \"data\": \"\"\n },\n \"sandboxBrightness\": \"\",\n \"sandboxSharpness\": \"\",\n \"sandboxLivenessConfidence\": \"\",\n \"sandboxSimilarity\": \"\",\n \"code\": \"\",\n \"accepted\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"OTHER\",\n \"cpf\": \"80323856505\",\n \"name\": \"\",\n \"birthDate\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "5. Assinatura Digital", "description": "Prepare e conclua a assinatura digital ICP-Brasil A1.", "item": [ { "id": "3b280715-b622-4d15-b5f9-cd6295b7f60b", "name": "Preparar assinatura digital", "request": { "name": "Preparar assinatura digital", "description": { "content": "Prepara o documento para assinatura digital com certificado ICP-Brasil A1.\nRetorna o hash que deve ser assinado pelo certificado do cliente.\n\nO cliente deve enviar a cadeia de certificados PEM para que o servidor\nprepare o placeholder no PDF (para documentos PDF) ou compute o hash\ndo arquivo inteiro (para documentos genéricos — CAdES .p7s com conteúdo anexado).\n\nO formato é determinado automaticamente pelo `documentFormat` da transação,\ndefinido no momento do upload do documento.\n\nRequer scope `transactions:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "prepare" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"certificateChainPems\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "8d6a20fb-58c7-4ceb-b7cf-a50c078c51c6", "name": "Hash para assinatura gerado com sucesso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "prepare" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"certificateChainPems\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"signatureRequestId\": \"\",\n \"hashToSign\": \"\",\n \"hashAlgorithm\": \"SHA-256\",\n \"signatureAlgorithm\": \"RSASSA-PKCS1-v1_5\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16cc4fed-7847-4f1b-8d46-d80861fed115", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "prepare" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"certificateChainPems\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "719ca51c-28de-4282-9cae-07db1171bfcd", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "prepare" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"certificateChainPems\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08640ce1-e248-4001-ae61-398ea8c3f78d", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "prepare" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"certificateChainPems\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3448051a-abcf-473e-b59d-148a3d1deb31", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "prepare" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"certificateChainPems\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd1d4afa-dd1d-499d-8039-887f6d604fdc", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "prepare" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"certificateChainPems\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c77a32c8-42a5-4eaa-97b4-8f0a6f127c6e", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.\n\nInclui o perfil de política não autorizado para o tenant. As rotas de criação\n(`/v1/transactions`, `/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`)\nverificam a mesma regra, antes de cota, convite e gravação — a recusa não consome\ndocumento. As flags envolvidas são `featureFlags.customPolicyEnabled` (perfil `CUSTOM`),\n`serpro.enabled` (perfis SERPRO), `featureFlags.documentExtractionEnabled` (fallback por\ndocumento; `BIOMETRIC_SERPRO_AUTO_FALLBACK` exige as duas últimas) e\n`featureFlags.biometricRequired`. O remédio é habilitar a flag para o tenant.\n\n`signer.cpf` e `signer.birthDate`, exigidos pelos perfis SERPRO, são validados como\n**400** e não aqui: requisição malformada, corrigível na mesma chamada.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "prepare" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"certificateChainPems\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cc0a3f5-5ea9-44d3-8351-87164d4a0a56", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "prepare" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"certificateChainPems\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dfbe0455-1af2-4fcf-9e8a-28b397a9ec71", "name": "Concluir assinatura digital", "request": { "name": "Concluir assinatura digital", "description": { "content": "Submete a assinatura digital bruta (raw signature) gerada pelo certificado A1 do cliente.\n\n- Para documentos PDF: o servidor injeta a assinatura no PDF (PAdES).\n- Para documentos genéricos: o servidor gera um arquivo `.p7s` CAdES com o conteúdo do documento anexado (enveloping).\n\nConclui a etapa `DIGITAL_SIGN_A1`.\n\nRequer scope `transactions:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "b4f48caf-70ee-4f1b-89e7-949a70ef7044", "name": "Assinatura digital concluída com sucesso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"status\": \"COMPLETED\",\n \"result\": {\n \"digitalSignature\": {\n \"certificateSubject\": \"\",\n \"certificateSerial\": \"\",\n \"certificateIssuer\": \"\",\n \"algorithm\": \"\",\n \"signedAt\": \"\",\n \"signedPdfHash\": \"\",\n \"signatureFieldName\": \"\",\n \"signedP7sHash\": \"\",\n \"documentFormat\": \"generic\",\n \"signatureTimestamp\": {\n \"genTime\": \"\",\n \"tsaName\": \"\",\n \"serial\": \"\",\n \"policyOid\": \"\",\n \"tokenSha256\": \"\"\n }\n }\n },\n \"stepId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5ea187b-6668-4df1-bcf3-fc063b9739c6", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38491c82-8704-4645-bfa7-c1dcacd2ee47", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbde2b7e-b537-45b8-b63e-f4d56c2f76f0", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed8259b8-df71-4f49-8a87-1e0aca5a73ee", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "765f64b2-b943-4d54-979c-de3999ba1572", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0be75b2e-7b97-4391-a44d-428aff4b55c2", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.\n\nInclui o perfil de política não autorizado para o tenant. As rotas de criação\n(`/v1/transactions`, `/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`)\nverificam a mesma regra, antes de cota, convite e gravação — a recusa não consome\ndocumento. As flags envolvidas são `featureFlags.customPolicyEnabled` (perfil `CUSTOM`),\n`serpro.enabled` (perfis SERPRO), `featureFlags.documentExtractionEnabled` (fallback por\ndocumento; `BIOMETRIC_SERPRO_AUTO_FALLBACK` exige as duas últimas) e\n`featureFlags.biometricRequired`. O remédio é habilitar a flag para o tenant.\n\n`signer.cpf` e `signer.birthDate`, exigidos pelos perfis SERPRO, são validados como\n**400** e não aqui: requisição malformada, corrigível na mesma chamada.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed77d705-bc0a-4220-be87-2f1345899f4f", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64ac4049-3f01-4696-affd-ff3ee83f3a41", "name": "Carimbo do tempo indisponível (`code: TIMESTAMP_UNAVAILABLE`, `retryable: true`). Só ocorre em\ntenants com carimbo do tempo habilitado. A solicitação de assinatura continua pendente: reenvie\na mesma assinatura após `Retry-After` segundos.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "signing", "complete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de reenviar.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "6. Finalizar", "description": "Finalize a transação e consulte a evidência gerada.", "item": [ { "id": "6a677dfc-6216-499b-b21e-b9a20ba4f632", "name": "Finalizar transação", "request": { "name": "Finalizar transação", "description": { "content": "Finaliza uma transação com todas as etapas concluídas, gerando o pacote de evidência\ncriptograficamente assinado (.p7m). O `evidenceId` retornado pode ser usado para\nverificação pública via `/v1/verify/{evidenceId}`.\n\nRequer scope `transactions:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "transactions", ":transactionId", "finalize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "8b2244d2-c9d1-4f1b-93fa-b0d1d4c56f79", "name": "Transação finalizada e evidência gerada com sucesso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "finalize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"transactionId\": \"\",\n \"status\": \"COMPLETED\",\n \"evidenceId\": \"\",\n \"evidenceHash\": \"\",\n \"completedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "186f46e0-c15c-46c5-b703-c3a17928def0", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "finalize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dce4ae7-0364-4e2a-9bb0-07a89757e22e", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "finalize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c12c1632-deae-45a8-8987-54dcac5c5e30", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "finalize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fc912b5-1c0f-4145-a345-2cb51e1a355a", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "finalize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "124d83c4-2231-4863-9522-f9d2e10e9303", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.\n\nInclui o perfil de política não autorizado para o tenant. As rotas de criação\n(`/v1/transactions`, `/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`)\nverificam a mesma regra, antes de cota, convite e gravação — a recusa não consome\ndocumento. As flags envolvidas são `featureFlags.customPolicyEnabled` (perfil `CUSTOM`),\n`serpro.enabled` (perfis SERPRO), `featureFlags.documentExtractionEnabled` (fallback por\ndocumento; `BIOMETRIC_SERPRO_AUTO_FALLBACK` exige as duas últimas) e\n`featureFlags.biometricRequired`. O remédio é habilitar a flag para o tenant.\n\n`signer.cpf` e `signer.birthDate`, exigidos pelos perfis SERPRO, são validados como\n**400** e não aqui: requisição malformada, corrigível na mesma chamada.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "finalize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b671005f-d998-4c05-936d-c5ca4fa48616", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "finalize" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "if (pm.response.code === 200) {", " const body = pm.response.json();", " if (body.evidenceId) {", " pm.environment.set(\"evidenceId\", body.evidenceId);", " }", " pm.test(\"Transação finalizada\", () => {", " pm.expect(body.status).to.eql(\"COMPLETED\");", " });", "}" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2e06e4d8-edb5-4c8d-8edd-ee5ecf02f4c7", "name": "Consultar evidência da transação", "request": { "name": "Consultar evidência da transação", "description": { "content": "Retorna os metadados do pacote de evidência gerado para a transação,\nincluindo hash, chave KMS e URL de download pré-assinada.\n\nRequer scope `evidence:read`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "transactions", ":transactionId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "5b68453e-5d1f-4fc2-9d18-21e447f98dc2", "name": "Evidência retornada com sucesso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"evidenceId\": \"\",\n \"transactionId\": \"\",\n \"evidenceHash\": \"\",\n \"signatureAlg\": \"\",\n \"createdAt\": \"\",\n \"downloadUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25570a49-dcfd-494f-9b8b-71df95e16d21", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7ad42fd-0439-4a6b-90a7-7c6cff592707", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8e07b64-8216-430f-9aa7-e7403c8ebfd0", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dd95671-5d36-4024-9782-77d91917f33c", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "evidence" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "7. Verificação Pública", "description": "Verifique evidências e baixe documentos assinados (rota pública, sem token).", "item": [ { "id": "50c20a88-ec16-43e6-bc02-1b6b99fffa8b", "name": "Verificar se um PDF está assinado", "request": { "name": "Verificar se um PDF está assinado", "description": { "content": "Recebe um PDF (base64) e informa se o documento **contém assinatura**,\nlistando as assinaturas encontradas. Útil para validar documentos de\nqualquer origem, sem necessidade de um identificador prévio.\n\nDetecção apenas de **assinaturas digitais embutidas** (PAdES/CAdES,\nvia dicionário de assinatura PKCS#7 com `/ByteRange`). Artefatos visuais\n(rubrica desenhada, carimbo, texto) **não** são considerados assinatura.\n**Não** extrai identidade do signatário (CPF/CNPJ), **não** valida cadeia\nde certificação ICP-Brasil nem revogação (OCSP/CRL), e **não** consulta\nregistros do SignDocs — é agnóstica ao provedor.\n\nO PDF é inspecionado em memória e descartado; nunca é armazenado.\n\nRequer scope `verification:write` e **credenciais de produção** — chaves\nde sandbox/homologação recebem `403`. Cada chamada consome uma unidade da\ncota `verification`.\n\nSuporta idempotência via header `X-Idempotency-Key`: reenviar a mesma\nchave com o mesmo PDF devolve a resposta original sem consumir cota\nnovamente.\n", "type": "text/plain" }, "url": { "path": [ "v1", "verify", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "679db205-13cc-4565-b6bb-2e9ae065efb9", "name": "Documento inspecionado com sucesso.", "originalRequest": { "url": { "path": [ "v1", "verify", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "RateLimit-Reset", "value": "" } ], "body": "{\n \"signed\": \"\",\n \"signatureCount\": \"\",\n \"signatures\": [\n {\n \"method\": \"\",\n \"type\": \"pkcs7\",\n \"confidence\": \"\",\n \"subFilter\": \"\",\n \"filter\": \"\"\n },\n {\n \"method\": \"\",\n \"type\": \"pkcs7\",\n \"confidence\": \"\",\n \"subFilter\": \"\",\n \"filter\": \"\"\n }\n ],\n \"checkedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca0f4286-174f-4400-9daf-759b7b3927df", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "verify", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e475dde9-a1a1-4d96-b95e-5a2e9d926337", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "verify", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64a4f1f1-cfa3-4770-b221-e3bf8b9a0fee", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "verify", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af00afbb-c1ed-464e-a689-db605d4e3f87", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "verify", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "52cc6261-6a74-413b-8704-540a355549c5", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.\n\nInclui o perfil de política não autorizado para o tenant. As rotas de criação\n(`/v1/transactions`, `/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`)\nverificam a mesma regra, antes de cota, convite e gravação — a recusa não consome\ndocumento. As flags envolvidas são `featureFlags.customPolicyEnabled` (perfil `CUSTOM`),\n`serpro.enabled` (perfis SERPRO), `featureFlags.documentExtractionEnabled` (fallback por\ndocumento; `BIOMETRIC_SERPRO_AUTO_FALLBACK` exige as duas últimas) e\n`featureFlags.biometricRequired`. O remédio é habilitar a flag para o tenant.\n\n`signer.cpf` e `signer.birthDate`, exigidos pelos perfis SERPRO, são validados como\n**400** e não aqui: requisição malformada, corrigível na mesma chamada.", "originalRequest": { "url": { "path": [ "v1", "verify", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "495a2f0a-0735-47dd-8c19-70c4744ad640", "name": "Limite de requisições excedido.", "originalRequest": { "url": { "path": [ "v1", "verify", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"content\": \"\",\n \"filename\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de tentar novamente.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0679909d-2bfc-4854-9f21-c0b1f36e6fef", "name": "Verificar envelope multi-signatário", "request": { "name": "Verificar envelope multi-signatário", "description": { "content": "Consulta pública de um envelope multi-signatário. Retorna o status\ndo envelope, lista de signatários (com `evidenceId` para drill-down\nem cada evidência), e URLs de download para artefatos consolidados\na nível de envelope.\n\n- `downloads.combinedSignedPdf`: presente quando o envelope é um\n PDF e todos os signatários concluíram (PDF combinado com todas as\n assinaturas embutidas).\n- `downloads.consolidatedSignature`: presente quando o envelope é\n um documento não-PDF assinado com certificado digital e todos os\n signatários concluíram. Contém o `.p7s` (PKCS#7 detached) com\n todos os `SignerInfo` consolidados em um único arquivo.\n\nEnvelopes criados com `signerConfidentiality: true` não expõem\nsignatários, contagens nem downloads aqui — nem após a conclusão.\n", "type": "text/plain" }, "url": { "path": [ "v1", "verify", "envelope", ":envelopeId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "envelopeId", "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "df5b1fb6-5cef-4ac1-93dd-5138994a827a", "name": "Envelope encontrado.", "originalRequest": { "url": { "path": [ "v1", "verify", "envelope", ":envelopeId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"envelopeId\": \"\",\n \"status\": \"EXPIRED\",\n \"signingMode\": \"SEQUENTIAL\",\n \"signerConfidentiality\": \"\",\n \"documentHash\": \"\",\n \"createdAt\": \"\",\n \"totalSigners\": \"\",\n \"completedSessions\": \"\",\n \"tenantName\": \"\",\n \"tenantCnpj\": \"\",\n \"signers\": [\n {\n \"signerIndex\": \"\",\n \"displayName\": \"\",\n \"status\": \"DOCUMENT_UPLOADED\",\n \"cpfCnpj\": \"\",\n \"policyProfile\": \"\",\n \"evidenceId\": \"\",\n \"completedAt\": \"\"\n },\n {\n \"signerIndex\": \"\",\n \"displayName\": \"\",\n \"status\": \"COMPLETED\",\n \"cpfCnpj\": \"\",\n \"policyProfile\": \"\",\n \"evidenceId\": \"\",\n \"completedAt\": \"\"\n }\n ],\n \"downloads\": {\n \"combinedSignedPdf\": {\n \"url\": \"\",\n \"filename\": \"\"\n },\n \"consolidatedSignature\": {\n \"url\": \"\",\n \"filename\": \"\"\n }\n },\n \"completedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bbdddfe-228e-454f-93e1-5cf806402e71", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "verify", "envelope", ":envelopeId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7fb790bf-2533-48a5-af81-a710391f4bca", "name": "Verificar evidência de assinatura", "request": { "name": "Verificar evidência de assinatura", "description": { "content": "Consulta pública de uma evidência de assinatura. Permite que terceiros verifiquem\na autenticidade de uma transação pelo `evidenceId`, sem necessidade de autenticação.\n", "type": "text/plain" }, "url": { "path": [ "v1", "verify", ":evidenceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "evidenceId", "disabled": false, "description": { "content": "(Required) Identificador único da evidência.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "74ce3989-9bf2-44c7-89c3-32d7e12b0e23", "name": "Evidência encontrada e verificada.", "originalRequest": { "url": { "path": [ "v1", "verify", ":evidenceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da evidência.", "type": "text/plain" }, "type": "any", "value": "", "key": "evidenceId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"evidenceId\": \"\",\n \"status\": \"\",\n \"transactionId\": \"\",\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"evidenceHash\": \"\",\n \"policy\": {\n \"profile\": \"CLICK_ONLY\",\n \"customSteps\": [\n \"BIOMETRIC_LIVENESS\",\n \"OTP_VERIFY\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"steps\": [\n {\n \"type\": \"CLICK_ACCEPT\",\n \"status\": \"SKIPPED\",\n \"order\": \"\",\n \"completedAt\": \"\",\n \"signatureTimestamp\": {\n \"genTime\": \"\",\n \"tsaName\": \"\",\n \"policyOid\": \"\"\n }\n },\n {\n \"type\": \"DIGITAL_SIGN_A1\",\n \"status\": \"STARTED\",\n \"order\": \"\",\n \"completedAt\": \"\",\n \"signatureTimestamp\": {\n \"genTime\": \"\",\n \"tsaName\": \"\",\n \"policyOid\": \"\"\n }\n }\n ],\n \"createdAt\": \"\",\n \"completedAt\": \"\",\n \"envelopeId\": \"\",\n \"documentHash\": \"\",\n \"signer\": {\n \"displayName\": \"\",\n \"cpfCnpj\": \"\"\n },\n \"tenantName\": \"\",\n \"tenantCnpj\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d589219-742c-4a14-b183-08d55e792bc3", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "verify", ":evidenceId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da evidência.", "type": "text/plain" }, "type": "any", "value": "", "key": "evidenceId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "19827a65-f0b5-4824-98ac-2a86af0dfbed", "name": "Obter downloads da evidência", "request": { "name": "Obter downloads da evidência", "description": { "content": "Retorna URLs pré-assinadas para download dos artefatos de evidência:\npacote de evidência (.p7m), PDF assinado e PDF final com carimbo visual.\n", "type": "text/plain" }, "url": { "path": [ "v1", "verify", ":evidenceId", "downloads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "evidenceId", "disabled": false, "description": { "content": "(Required) Identificador único da evidência.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "20b5f0a6-41d1-4e04-a5df-c625393ccad0", "name": "URLs de download geradas com sucesso.", "originalRequest": { "url": { "path": [ "v1", "verify", ":evidenceId", "downloads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da evidência.", "type": "text/plain" }, "type": "any", "value": "", "key": "evidenceId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"evidenceId\": \"\",\n \"downloads\": {\n \"originalDocument\": \"\",\n \"evidencePack\": \"\",\n \"finalPdf\": \"\",\n \"signedSignature\": \"\"\n },\n \"signerConfidentiality\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "350fc0cf-acd3-486d-a3ce-6b79b1a978f4", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "verify", ":evidenceId", "downloads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da evidência.", "type": "text/plain" }, "type": "any", "value": "", "key": "evidenceId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "8. Webhooks", "description": "Registre, liste, teste e remova webhooks de notificação.", "item": [ { "id": "52ad00af-db8d-4bfb-bfe3-c360b8898457", "name": "Registrar webhook", "request": { "name": "Registrar webhook", "description": { "content": "Registra um novo endpoint de webhook para receber notificações de eventos.\nO `secret` retornado na resposta é exibido apenas neste momento — armazene-o\ncom segurança para validar as assinaturas HMAC-SHA256 dos payloads recebidos.\n\nUma URL que já tem um webhook `ACTIVE` no tenant é recusada com `409`, qualquer\nque seja a lista de eventos; o `webhookId` existente vem no `detail`. Para mudar\nos eventos, remova o registro (`DELETE /v1/webhooks/{webhookId}`) e registre a\nURL de novo — o novo registro recebe um novo `secret`.\n\nRequer scope `webhooks:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://meu-sistema.exemplo.com.br/webhooks/signdocs\",\n \"events\": [\n \"TRANSACTION.COMPLETED\",\n \"TRANSACTION.FAILED\",\n \"SIGNING_SESSION.COMPLETED\",\n \"QUOTA.WARNING\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "76e237a6-9f8b-4fe7-9855-d277cf2c28fd", "name": "Webhook registrado com sucesso. O `secret` é retornado apenas nesta resposta.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"ENVELOPE.CREATED\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"webhookId\": \"\",\n \"url\": \"\",\n \"secret\": \"\",\n \"events\": [\n \"ENROLLMENT.EXPIRING\",\n \"TRANSACTION.FALLBACK\"\n ],\n \"status\": \"ACTIVE\",\n \"createdAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8e01259-8b12-4b35-8c30-6e1d72e1c0be", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"ENVELOPE.CREATED\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1356c3d3-eb23-45ce-8703-eec695e570a8", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"ENVELOPE.CREATED\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e0d8c7a1-43d2-4043-a279-b96074327b38", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"ENVELOPE.CREATED\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "847bd040-fc49-47fb-a90d-84432df590ab", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"ENVELOPE.CREATED\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f1b18c9-feb1-40f1-a032-c492d4a06576", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.\n\nInclui o perfil de política não autorizado para o tenant. As rotas de criação\n(`/v1/transactions`, `/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`)\nverificam a mesma regra, antes de cota, convite e gravação — a recusa não consome\ndocumento. As flags envolvidas são `featureFlags.customPolicyEnabled` (perfil `CUSTOM`),\n`serpro.enabled` (perfis SERPRO), `featureFlags.documentExtractionEnabled` (fallback por\ndocumento; `BIOMETRIC_SERPRO_AUTO_FALLBACK` exige as duas últimas) e\n`featureFlags.biometricRequired`. O remédio é habilitar a flag para o tenant.\n\n`signer.cpf` e `signer.birthDate`, exigidos pelos perfis SERPRO, são validados como\n**400** e não aqui: requisição malformada, corrigível na mesma chamada.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"ENVELOPE.CREATED\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93f8c536-8d77-4038-a27e-a2ed78b94dcb", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"ENVELOPE.CREATED\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "if (pm.response.code === 201) {", " const body = pm.response.json();", " pm.environment.set(\"webhookId\", body.webhookId);", " pm.test(\"Webhook registrado\", () => {", " pm.expect(body.webhookId).to.be.a(\"string\");", " pm.expect(body.secret).to.be.a(\"string\");", " });", "}" ] } } ], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6cd61e16-0c37-4dbd-b9a2-7fe39f75b111", "name": "Listar webhooks", "request": { "name": "Listar webhooks", "description": { "content": "Retorna todos os webhooks registrados pelo tenant autenticado.\n\nRequer scope `webhooks:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "758c57bb-95fd-4389-a161-081985431a84", "name": "Lista de webhooks retornada com sucesso.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"webhooks\": [\n {\n \"webhookId\": \"\",\n \"url\": \"\",\n \"events\": [\n \"ENVELOPE.CANCELLED\",\n \"TRANSACTION.CREATED\"\n ],\n \"status\": \"ACTIVE\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"webhookId\": \"\",\n \"url\": \"\",\n \"events\": [\n \"QUOTA.WARNING\",\n \"SIGNING_SESSION.CANCELLED\"\n ],\n \"status\": \"DISABLED\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46344a39-5aaf-4f1f-90cf-750008b64bf3", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74b574ae-a262-4c40-8272-83a2033f0e6e", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3fee607-3b26-4f14-83f2-6cb6c0099c15", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "85a1f1b9-3d32-4c0e-b286-f8d8db336c59", "name": "Remover webhook", "request": { "name": "Remover webhook", "description": { "content": "Remove um webhook registrado. Após a remoção, nenhuma nova notificação será enviada\npara o endpoint.\n\nRequer scope `webhooks:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "webhookId", "disabled": false, "description": { "content": "(Required) Identificador único do webhook.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "9a0862f9-d117-48cb-977f-07d68ce0929c", "name": "Webhook removido com sucesso.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do webhook.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f8219e64-be0c-4d2c-a3f8-a490487fafa1", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do webhook.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc409ae6-cf5c-448f-85b2-33c895a0c0ba", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do webhook.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61e8517e-89a2-47b3-aa86-c716adc14ae6", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do webhook.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "74f4a97b-06e2-4187-b03d-cbdfe9490b88", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do webhook.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "48c19e1c-1668-4b51-9469-2e1800e38ffb", "name": "Testar webhook", "request": { "name": "Testar webhook", "description": { "content": "Envia um payload de teste para o endpoint do webhook e retorna o resultado da entrega.\nÚtil para verificar conectividade e configuração do webhook.\n\nRequer scope `webhooks:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":webhookId", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "webhookId", "disabled": false, "description": { "content": "(Required) Identificador único do webhook.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "88e8e2df-3cab-4aba-a272-fda05495a961", "name": "Resultado do teste de entrega.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do webhook.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"webhookId\": \"\",\n \"testDelivery\": {\n \"httpStatus\": \"\",\n \"success\": \"\",\n \"timestamp\": \"\",\n \"error\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3230f82-cb26-4c44-8ea4-0bc92f30b551", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do webhook.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e2b40af1-cb73-48bc-aa1d-ac50a1d057e2", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do webhook.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe3a760d-8ca8-4744-bfe6-8a9bfc9a09d4", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do webhook.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f4f7ef3-3ee3-40a1-90a6-b63ada0872b1", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":webhookId", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do webhook.", "type": "text/plain" }, "type": "any", "value": "", "key": "webhookId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "9. Usuários", "description": "Cadastro e enrollment biométrico de usuários.", "item": [ { "id": "d85ef24c-7dc0-4227-8395-7a6e5e3ca8b5", "name": "Cadastra vários usuários numa requisição", "request": { "name": "Cadastra vários usuários numa requisição", "description": { "content": "Cadastra até **25** usuários de uma vez, para popular a base no dia da\nvirada sem disparar um `PUT` por funcionário.\n\n**Sucesso parcial é o comportamento pretendido.** Uma foto ruim entre\nvinte e cinco não pode reprovar as outras vinte e quatro, então cada\nlinha reporta o próprio resultado e a resposta é **200 mesmo quando há\nlinhas reprovadas**. Leia `results`, não o código HTTP — quem trata só o\nstatus considera aprovado um lote em que metade falhou.\n\n`userExternalId` repetido no mesmo lote é **400**: as linhas correriam\nsobre a mesma chave e a versão final ficaria imprevisível.\n\n**Limite real é o tamanho do corpo, não as 25 linhas.** A invocação\nsíncrona da Lambda corta em ~6 MB, e a imagem em base64 cresce um terço.\nMedido em HML: 25 fotos de 53 KB = 1,82 MB, aprovado em 5 s; 8 fotos de\n536 KB = 5,72 MB passa, 9 = 6,44 MB devolve **413**. Para usar as 25\nvagas, mantenha cada foto abaixo de ~175 KB — 640×640 com qualidade 82\ndá 53 KB e ainda detecta rosto com 99,99 de confiança.\n\nCadastrar **não** consome cota: nem de documento, nem de biometria. A\ncota é debitada quando a assinatura acontece, não quando o funcionário\nentra na base.\n", "type": "text/plain" }, "url": { "path": [ "v1", "users", "enrollments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"enrollments\": [\n {\n \"cpf\": \"56969628661\",\n \"image\": \"\",\n \"userExternalId\": \"\",\n \"dryRun\": false,\n \"source\": \"ORGANIZATION_PROVIDED\"\n }\n ],\n \"dryRun\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "2abb159b-df08-46a5-9191-e41ab4b50bde", "name": "Lote processado. Pode conter linhas reprovadas — confira `failed` e\no `status` de cada item em `results`.", "originalRequest": { "url": { "path": [ "v1", "users", "enrollments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"enrollments\": [\n {\n \"cpf\": \"56969628661\",\n \"image\": \"\",\n \"userExternalId\": \"\",\n \"dryRun\": false,\n \"source\": \"ORGANIZATION_PROVIDED\"\n }\n ],\n \"dryRun\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"submitted\": \"\",\n \"succeeded\": \"\",\n \"failed\": \"\",\n \"dryRun\": \"\",\n \"usable\": \"\",\n \"marginal\": \"\",\n \"rejected\": \"\",\n \"results\": [\n {\n \"index\": \"\",\n \"referenceQuality\": \"rejected\",\n \"quality\": {\n \"brightness\": \"\",\n \"sharpness\": \"\"\n },\n \"pose\": {\n \"yaw\": \"\",\n \"pitch\": \"\",\n \"roll\": \"\"\n },\n \"faceCoverage\": \"\",\n \"warnings\": [\n \"FACE_TOO_SMALL\",\n \"HEAD_TURNED\"\n ],\n \"userExternalId\": \"\",\n \"status\": \"usable\",\n \"enrollmentVersion\": \"\",\n \"expiresAt\": \"\",\n \"faceConfidence\": \"\",\n \"error\": \"\"\n },\n {\n \"index\": \"\",\n \"referenceQuality\": \"usable\",\n \"quality\": {\n \"brightness\": \"\",\n \"sharpness\": \"\"\n },\n \"pose\": {\n \"yaw\": \"\",\n \"pitch\": \"\",\n \"roll\": \"\"\n },\n \"faceCoverage\": \"\",\n \"warnings\": [\n \"LOW_BRIGHTNESS\",\n \"LOW_BRIGHTNESS\"\n ],\n \"userExternalId\": \"\",\n \"status\": \"marginal\",\n \"enrollmentVersion\": \"\",\n \"expiresAt\": \"\",\n \"faceConfidence\": \"\",\n \"error\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a36c7f3-b605-4d5b-9a5e-1a2580cd2182", "name": "Lote vazio, acima de 25 itens, ou `userExternalId` repetido.", "originalRequest": { "url": { "path": [ "v1", "users", "enrollments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"enrollments\": [\n {\n \"cpf\": \"56969628661\",\n \"image\": \"\",\n \"userExternalId\": \"\",\n \"dryRun\": false,\n \"source\": \"ORGANIZATION_PROVIDED\"\n }\n ],\n \"dryRun\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ee8103d-d21e-4857-ba31-554b277c7a10", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "users", "enrollments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"enrollments\": [\n {\n \"cpf\": \"56969628661\",\n \"image\": \"\",\n \"userExternalId\": \"\",\n \"dryRun\": false,\n \"source\": \"ORGANIZATION_PROVIDED\"\n }\n ],\n \"dryRun\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6fd150fb-e77e-4ad5-8f72-fc7ef0afc7e3", "name": "Consultar o enrollment biométrico", "request": { "name": "Consultar o enrollment biométrico", "description": { "content": "Informa se o usuário tem enrollment e **até quando**.\n\nA imagem de referência é apagada por ciclo de vida do S3 90 dias após o\ncadastro, mas o registro do enrollment permanece. Quem só pergunta \"esse\nusuário está cadastrado?\" recebe sim muito depois da foto ter sumido, e\ndescobre o problema como um 422 no meio da assinatura. `expiresAt` e\n`expired` existem para permitir uma varredura de recadastramento antes\ndisso.\n\nO CPF volta mascarado: a rota é enumerável por `userExternalId`.\n\nRequer scope `transactions:read`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userExternalId", "disabled": false, "description": { "content": "(Required) Identificador do usuário no sistema do integrador.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "5cecc42c-abda-4af9-9731-d1c9c967f880", "name": "Enrollment encontrado.", "originalRequest": { "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador do usuário no sistema do integrador.", "type": "text/plain" }, "type": "any", "value": "", "key": "userExternalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"userExternalId\": \"\",\n \"enrollmentSource\": \"DOCUMENT_PHOTO\",\n \"enrollmentVersion\": \"\",\n \"enrollmentHash\": \"\",\n \"enrolledAt\": \"\",\n \"expiresAt\": \"\",\n \"expired\": \"\",\n \"retentionDays\": \"\",\n \"maskedCpf\": \"\",\n \"faceConfidence\": \"\",\n \"documentImageHash\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84f9e816-af18-4232-b7f9-6af99335bed7", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador do usuário no sistema do integrador.", "type": "text/plain" }, "type": "any", "value": "", "key": "userExternalId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91f233c7-f3f0-4a1b-902d-6ac25079dadb", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador do usuário no sistema do integrador.", "type": "text/plain" }, "type": "any", "value": "", "key": "userExternalId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "434de511-d4b6-46c7-ac16-640d3a50f3fc", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador do usuário no sistema do integrador.", "type": "text/plain" }, "type": "any", "value": "", "key": "userExternalId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b19b398f-4ada-46ea-9b7f-4e429926c5ae", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador do usuário no sistema do integrador.", "type": "text/plain" }, "type": "any", "value": "", "key": "userExternalId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e3f55aa0-018a-4184-b0bb-015874478b5d", "name": "Apagar o enrollment biométrico", "request": { "name": "Apagar o enrollment biométrico", "description": { "content": "Elimina a imagem de referência, a imagem original do documento quando o\ncadastro veio de uma, e o registro do enrollment.\n\nExiste para atender o direito de eliminação (LGPD art. 18): um\nfuncionário que sai da empresa não deveria esperar os 90 dias de\nretenção para a face dele desaparecer.\n\nOs objetos no S3 são removidos antes do registro, e cada remoção é\ngravada no log de acesso biométrico — essa entrada é a evidência de que\no apagamento aconteceu.\n\n**Transações em andamento que dependiam desse enrollment passam a falhar\na etapa de comparação com 422.** É a consequência esperada de um pedido\nde eliminação.\n\nRequer scope `transactions:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userExternalId", "disabled": false, "description": { "content": "(Required) Identificador do usuário no sistema do integrador.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "595b094c-e269-4223-ab6d-4f507fe56657", "name": "Enrollment apagado.", "originalRequest": { "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador do usuário no sistema do integrador.", "type": "text/plain" }, "type": "any", "value": "", "key": "userExternalId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"userExternalId\": \"\",\n \"deleted\": \"\",\n \"deletedAt\": \"\",\n \"enrollmentVersion\": \"\",\n \"objectsDeleted\": \"\",\n \"versionsDeleted\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0a44d0f-a9b2-40d7-b5d2-e2dd15293df2", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador do usuário no sistema do integrador.", "type": "text/plain" }, "type": "any", "value": "", "key": "userExternalId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfb7d83b-3671-46f3-8e35-02e682d93245", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador do usuário no sistema do integrador.", "type": "text/plain" }, "type": "any", "value": "", "key": "userExternalId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2005f720-179e-402d-a64e-9fe856c30e60", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador do usuário no sistema do integrador.", "type": "text/plain" }, "type": "any", "value": "", "key": "userExternalId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d60fa1bb-4e41-40ff-afb4-26108bdc9d4e", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador do usuário no sistema do integrador.", "type": "text/plain" }, "type": "any", "value": "", "key": "userExternalId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2852bf79-7b98-49cc-ac7e-8f70db144283", "name": "Cadastrar ou atualizar enrollment biométrico", "request": { "name": "Cadastrar ou atualizar enrollment biométrico", "description": "Cadastra ou atualiza o enrollment biométrico de um usuário.\n\n**Fontes disponíveis** (`source`):\n- `BANK_PROVIDED` (padrão) — selfie ou foto fornecida pelo banco\n- `FIRST_LIVENESS` — imagem capturada na primeira sessão de liveness\n- `DOCUMENT_PHOTO` — foto de documento (CNH/RG/passaporte). A face é extraída automaticamente. Requer `documentExtractionEnabled` no tenant.\n\n**Exemplo com DOCUMENT_PHOTO**:\n```json\n{\n \"image\": \"\",\n \"cpf\": \"12345678909\",\n \"source\": \"DOCUMENT_PHOTO\"\n}\n```\n\nO campo `cpf` é obrigatório em todas as fontes.", "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "userExternalId", "disabled": false, "description": { "content": "(Required) Identificador externo do usuário no sistema do integrador.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"image\": \"/9j/4AAQSkZJRg... (substitua pelo conteúdo base64 da imagem JPEG)\",\n \"cpf\": \"12345678909\",\n \"source\": \"BANK_PROVIDED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "efb892ab-665f-40cf-b23e-7f5b31adc762", "name": "Enrollment realizado com sucesso.", "originalRequest": { "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador externo do usuário no sistema do integrador.", "type": "text/plain" }, "type": "any", "value": "", "key": "userExternalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"image\": \"\",\n \"cpf\": \"43130433091\",\n \"dryRun\": false,\n \"source\": \"ORGANIZATION_PROVIDED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"userExternalId\": \"\",\n \"enrollmentHash\": \"\",\n \"enrollmentVersion\": \"\",\n \"enrollmentSource\": \"BANK_PROVIDED\",\n \"enrolledAt\": \"\",\n \"cpf\": \"\",\n \"faceConfidence\": \"\",\n \"documentImageHash\": \"\",\n \"referenceQuality\": \"rejected\",\n \"quality\": {\n \"brightness\": \"\",\n \"sharpness\": \"\"\n },\n \"pose\": {\n \"yaw\": \"\",\n \"pitch\": \"\",\n \"roll\": \"\"\n },\n \"faceCoverage\": \"\",\n \"warnings\": [\n \"LOW_BRIGHTNESS\",\n \"FACE_TOO_SMALL\"\n ],\n \"extractionConfidence\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05827c08-bcb9-4173-a45d-641b83b95e13", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador externo do usuário no sistema do integrador.", "type": "text/plain" }, "type": "any", "value": "", "key": "userExternalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"image\": \"\",\n \"cpf\": \"43130433091\",\n \"dryRun\": false,\n \"source\": \"ORGANIZATION_PROVIDED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35a47127-c9e9-40ab-b1e5-d9c61fe64c7d", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador externo do usuário no sistema do integrador.", "type": "text/plain" }, "type": "any", "value": "", "key": "userExternalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"image\": \"\",\n \"cpf\": \"43130433091\",\n \"dryRun\": false,\n \"source\": \"ORGANIZATION_PROVIDED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b491d48-8b0c-4cc6-981b-7e8b1d757bc2", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador externo do usuário no sistema do integrador.", "type": "text/plain" }, "type": "any", "value": "", "key": "userExternalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"image\": \"\",\n \"cpf\": \"43130433091\",\n \"dryRun\": false,\n \"source\": \"ORGANIZATION_PROVIDED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63e1ae89-6a3b-4253-9ca3-92007657b7d3", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.\n\nInclui o perfil de política não autorizado para o tenant. As rotas de criação\n(`/v1/transactions`, `/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`)\nverificam a mesma regra, antes de cota, convite e gravação — a recusa não consome\ndocumento. As flags envolvidas são `featureFlags.customPolicyEnabled` (perfil `CUSTOM`),\n`serpro.enabled` (perfis SERPRO), `featureFlags.documentExtractionEnabled` (fallback por\ndocumento; `BIOMETRIC_SERPRO_AUTO_FALLBACK` exige as duas últimas) e\n`featureFlags.biometricRequired`. O remédio é habilitar a flag para o tenant.\n\n`signer.cpf` e `signer.birthDate`, exigidos pelos perfis SERPRO, são validados como\n**400** e não aqui: requisição malformada, corrigível na mesma chamada.", "originalRequest": { "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador externo do usuário no sistema do integrador.", "type": "text/plain" }, "type": "any", "value": "", "key": "userExternalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"image\": \"\",\n \"cpf\": \"43130433091\",\n \"dryRun\": false,\n \"source\": \"ORGANIZATION_PROVIDED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5231b8c-5f9a-4d98-82c9-746cd59f2789", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "users", ":userExternalId", "enrollment" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador externo do usuário no sistema do integrador.", "type": "text/plain" }, "type": "any", "value": "", "key": "userExternalId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"image\": \"\",\n \"cpf\": \"43130433091\",\n \"dryRun\": false,\n \"source\": \"ORGANIZATION_PROVIDED\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "10. Assinatura Expressa", "description": "Crie sessões de assinatura hospedadas, consulte status, cancele e liste sessões.", "item": [ { "id": "3e7adb50-e8d8-4839-af08-6e42eeb1e3c0", "name": "Criar sessão de assinatura", "request": { "name": "Criar sessão de assinatura", "description": { "content": "Cria uma sessão de assinatura expressa (Assinatura Expressa). Cria atomicamente transação,\netapas, documento e token de embed. Retorna sessionId, url e clientSecret.\n\nO link entregue ao signatário é `{url}?cs={clientSecret}` — a `url` sozinha não abre,\nporque o `clientSecret` é a autenticação da sessão. Veja a descrição do campo `url`.\n\nRequer scope `transactions:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "signing-sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"DIGITAL_CERTIFICATE\",\n \"customSteps\": [\n \"BIOMETRIC_LIVENESS\",\n \"DOCUMENT_PHOTO_MATCH\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"signer\": {\n \"cpf\": 3105.932439309449\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"referenceImage\": {\n \"content\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"expiresInMinutes\": 60,\n \"appearance\": {\n \"brandColor\": \"#f367E9\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#6aaB41\",\n \"textColor\": \"#f6d233\",\n \"buttonTextColor\": \"#e3345a\",\n \"borderRadius\": \"2413741831px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"deliverVia\": [\n \"telegram\",\n \"telegram\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "ef458c03-1819-440c-8750-03dae4e4bf84", "name": "Sessão de assinatura criada com sucesso.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"DIGITAL_CERTIFICATE\",\n \"customSteps\": [\n \"BIOMETRIC_LIVENESS\",\n \"DOCUMENT_PHOTO_MATCH\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"signer\": {\n \"cpf\": 3105.932439309449\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"referenceImage\": {\n \"content\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"expiresInMinutes\": 60,\n \"appearance\": {\n \"brandColor\": \"#f367E9\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#6aaB41\",\n \"textColor\": \"#f6d233\",\n \"buttonTextColor\": \"#e3345a\",\n \"borderRadius\": \"2413741831px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"deliverVia\": [\n \"telegram\",\n \"telegram\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "URL do recurso criado.", "type": "text/plain" }, "key": "Location", "value": "" } ], "body": "{\n \"sessionId\": \"\",\n \"transactionId\": \"\",\n \"status\": \"ACTIVE\",\n \"url\": \"\",\n \"clientSecret\": \"\",\n \"expiresAt\": \"\",\n \"createdAt\": \"\",\n \"inviteSent\": \"\",\n \"whatsappInviteSent\": \"\",\n \"telegramInviteSent\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5fde5f0c-26ea-4782-81e5-902b9c959244", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"DIGITAL_CERTIFICATE\",\n \"customSteps\": [\n \"BIOMETRIC_LIVENESS\",\n \"DOCUMENT_PHOTO_MATCH\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"signer\": {\n \"cpf\": 3105.932439309449\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"referenceImage\": {\n \"content\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"expiresInMinutes\": 60,\n \"appearance\": {\n \"brandColor\": \"#f367E9\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#6aaB41\",\n \"textColor\": \"#f6d233\",\n \"buttonTextColor\": \"#e3345a\",\n \"borderRadius\": \"2413741831px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"deliverVia\": [\n \"telegram\",\n \"telegram\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c84d87b-9972-4d61-ac0f-50254bea07ca", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"DIGITAL_CERTIFICATE\",\n \"customSteps\": [\n \"BIOMETRIC_LIVENESS\",\n \"DOCUMENT_PHOTO_MATCH\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"signer\": {\n \"cpf\": 3105.932439309449\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"referenceImage\": {\n \"content\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"expiresInMinutes\": 60,\n \"appearance\": {\n \"brandColor\": \"#f367E9\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#6aaB41\",\n \"textColor\": \"#f6d233\",\n \"buttonTextColor\": \"#e3345a\",\n \"borderRadius\": \"2413741831px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"deliverVia\": [\n \"telegram\",\n \"telegram\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47c7ae85-669b-43b5-ab58-44b56dba1c56", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"DIGITAL_CERTIFICATE\",\n \"customSteps\": [\n \"BIOMETRIC_LIVENESS\",\n \"DOCUMENT_PHOTO_MATCH\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"signer\": {\n \"cpf\": 3105.932439309449\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"referenceImage\": {\n \"content\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"expiresInMinutes\": 60,\n \"appearance\": {\n \"brandColor\": \"#f367E9\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#6aaB41\",\n \"textColor\": \"#f6d233\",\n \"buttonTextColor\": \"#e3345a\",\n \"borderRadius\": \"2413741831px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"deliverVia\": [\n \"telegram\",\n \"telegram\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cb3b540-61c4-480a-af45-0c4eccab15ad", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"DIGITAL_CERTIFICATE\",\n \"customSteps\": [\n \"BIOMETRIC_LIVENESS\",\n \"DOCUMENT_PHOTO_MATCH\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"signer\": {\n \"cpf\": 3105.932439309449\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"referenceImage\": {\n \"content\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"expiresInMinutes\": 60,\n \"appearance\": {\n \"brandColor\": \"#f367E9\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#6aaB41\",\n \"textColor\": \"#f6d233\",\n \"buttonTextColor\": \"#e3345a\",\n \"borderRadius\": \"2413741831px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"deliverVia\": [\n \"telegram\",\n \"telegram\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46f8c77f-74af-4c60-bc2b-1c4b2905c6fd", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.\n\nInclui o perfil de política não autorizado para o tenant. As rotas de criação\n(`/v1/transactions`, `/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`)\nverificam a mesma regra, antes de cota, convite e gravação — a recusa não consome\ndocumento. As flags envolvidas são `featureFlags.customPolicyEnabled` (perfil `CUSTOM`),\n`serpro.enabled` (perfis SERPRO), `featureFlags.documentExtractionEnabled` (fallback por\ndocumento; `BIOMETRIC_SERPRO_AUTO_FALLBACK` exige as duas últimas) e\n`featureFlags.biometricRequired`. O remédio é habilitar a flag para o tenant.\n\n`signer.cpf` e `signer.birthDate`, exigidos pelos perfis SERPRO, são validados como\n**400** e não aqui: requisição malformada, corrigível na mesma chamada.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"DIGITAL_CERTIFICATE\",\n \"customSteps\": [\n \"BIOMETRIC_LIVENESS\",\n \"DOCUMENT_PHOTO_MATCH\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"signer\": {\n \"cpf\": 3105.932439309449\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"referenceImage\": {\n \"content\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"expiresInMinutes\": 60,\n \"appearance\": {\n \"brandColor\": \"#f367E9\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#6aaB41\",\n \"textColor\": \"#f6d233\",\n \"buttonTextColor\": \"#e3345a\",\n \"borderRadius\": \"2413741831px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"deliverVia\": [\n \"telegram\",\n \"telegram\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "226a3e14-0221-4323-9958-6371ad3028c7", "name": "Limite de requisições excedido.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"DIGITAL_CERTIFICATE\",\n \"customSteps\": [\n \"BIOMETRIC_LIVENESS\",\n \"DOCUMENT_PHOTO_MATCH\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"signer\": {\n \"cpf\": 3105.932439309449\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"referenceImage\": {\n \"content\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"expiresInMinutes\": 60,\n \"appearance\": {\n \"brandColor\": \"#f367E9\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#6aaB41\",\n \"textColor\": \"#f6d233\",\n \"buttonTextColor\": \"#e3345a\",\n \"borderRadius\": \"2413741831px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"deliverVia\": [\n \"telegram\",\n \"telegram\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de tentar novamente.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adaab847-1e49-4f78-bc0c-cea1a6af6d0c", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"DIGITAL_CERTIFICATE\",\n \"customSteps\": [\n \"BIOMETRIC_LIVENESS\",\n \"DOCUMENT_PHOTO_MATCH\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"signer\": {\n \"cpf\": 3105.932439309449\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"referenceImage\": {\n \"content\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"expiresInMinutes\": 60,\n \"appearance\": {\n \"brandColor\": \"#f367E9\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#6aaB41\",\n \"textColor\": \"#f6d233\",\n \"buttonTextColor\": \"#e3345a\",\n \"borderRadius\": \"2413741831px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"deliverVia\": [\n \"telegram\",\n \"telegram\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "053c9278-9be9-4a52-b333-12bdb13d7258", "name": "Serviço temporariamente indisponível.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"DIGITAL_CERTIFICATE\",\n \"customSteps\": [\n \"BIOMETRIC_LIVENESS\",\n \"DOCUMENT_PHOTO_MATCH\"\n ],\n \"minSimilarity\": \"\",\n \"minLivenessConfidence\": \"\"\n },\n \"signer\": {\n \"cpf\": 3105.932439309449\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"referenceImage\": {\n \"content\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"expiresInMinutes\": 60,\n \"appearance\": {\n \"brandColor\": \"#f367E9\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#6aaB41\",\n \"textColor\": \"#f6d233\",\n \"buttonTextColor\": \"#e3345a\",\n \"borderRadius\": \"2413741831px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"deliverVia\": [\n \"telegram\",\n \"telegram\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de tentar novamente.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ca01b7b0-2bd8-4bb8-b9bc-cefab590e9b7", "name": "Listar sessões de assinatura", "request": { "name": "Listar sessões de assinatura", "description": { "content": "Retorna uma lista paginada de sessões de assinatura filtradas por status.\nSuporta paginação via cursor.\n\nRequer scope `transactions:read`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "signing-sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Filtrar por status da sessão. (This can only be one of ACTIVE,COMPLETED,CANCELLED,EXPIRED,FAILED)", "type": "text/plain" }, "key": "status", "value": "ACTIVE" }, { "disabled": false, "description": { "content": "Número máximo de resultados por página (máximo 100).", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Cursor de paginação retornado pela consulta anterior.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "4dbf6278-fb4d-4829-a25e-c525ec4e5898", "name": "Lista de sessões retornada com sucesso.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Filtrar por status da sessão. (This can only be one of ACTIVE,COMPLETED,CANCELLED,EXPIRED,FAILED)", "type": "text/plain" }, "key": "status", "value": "ACTIVE" }, { "disabled": false, "description": { "content": "Número máximo de resultados por página (máximo 100).", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Cursor de paginação retornado pela consulta anterior.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"sessions\": [\n {\n \"sessionId\": \"\",\n \"transactionId\": \"\",\n \"status\": \"EXPIRED\",\n \"createdAt\": \"\",\n \"expiresAt\": \"\",\n \"locale\": \"\"\n },\n {\n \"sessionId\": \"\",\n \"transactionId\": \"\",\n \"status\": \"EXPIRED\",\n \"createdAt\": \"\",\n \"expiresAt\": \"\",\n \"locale\": \"\"\n }\n ],\n \"nextCursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "033d2a6f-987d-4040-a21e-4327bc39ceff", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Filtrar por status da sessão. (This can only be one of ACTIVE,COMPLETED,CANCELLED,EXPIRED,FAILED)", "type": "text/plain" }, "key": "status", "value": "ACTIVE" }, { "disabled": false, "description": { "content": "Número máximo de resultados por página (máximo 100).", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Cursor de paginação retornado pela consulta anterior.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed8b4be3-c970-4c78-b3dc-78a1a615cbad", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Filtrar por status da sessão. (This can only be one of ACTIVE,COMPLETED,CANCELLED,EXPIRED,FAILED)", "type": "text/plain" }, "key": "status", "value": "ACTIVE" }, { "disabled": false, "description": { "content": "Número máximo de resultados por página (máximo 100).", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Cursor de paginação retornado pela consulta anterior.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c658ccdb-9f16-40e3-9803-646a3d5b09df", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Filtrar por status da sessão. (This can only be one of ACTIVE,COMPLETED,CANCELLED,EXPIRED,FAILED)", "type": "text/plain" }, "key": "status", "value": "ACTIVE" }, { "disabled": false, "description": { "content": "Número máximo de resultados por página (máximo 100).", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Cursor de paginação retornado pela consulta anterior.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc805212-97a9-419e-be9b-b30c3e26b35d", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Filtrar por status da sessão. (This can only be one of ACTIVE,COMPLETED,CANCELLED,EXPIRED,FAILED)", "type": "text/plain" }, "key": "status", "value": "ACTIVE" }, { "disabled": false, "description": { "content": "Número máximo de resultados por página (máximo 100).", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Cursor de paginação retornado pela consulta anterior.", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6dbf3584-ddc1-458a-8721-70d03a300f90", "name": "Obter dados de bootstrap da sessão", "request": { "name": "Obter dados de bootstrap da sessão", "description": { "content": "Retorna os dados de bootstrap para o aplicativo de assinatura hospedado ou widget.\n\nAutenticação via embedToken (clientSecret).\n", "type": "text/plain" }, "url": { "path": [ "v1", "signing-sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "sessionId", "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "0f378a87-1f5d-484b-ba07-e6725ad6f911", "name": "Dados de bootstrap retornados com sucesso.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"sessionId\": \"\",\n \"transactionId\": \"\",\n \"status\": \"FAILED\",\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"signer\": {\n \"name\": \"\",\n \"maskedEmail\": \"\",\n \"maskedCpf\": \"\",\n \"maskedPhone\": \"\",\n \"otpChannel\": \"email\",\n \"otpChannelSelectable\": \"\",\n \"availableOtpChannels\": [\n \"email\",\n \"email\"\n ]\n },\n \"steps\": [\n {\n \"stepId\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"order\": \"\"\n },\n {\n \"stepId\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"order\": \"\"\n }\n ],\n \"locale\": \"\",\n \"expiresAt\": \"\",\n \"document\": {\n \"presignedUrl\": \"\",\n \"filename\": \"\",\n \"hash\": \"\"\n },\n \"action\": {\n \"type\": \"\",\n \"description\": \"\",\n \"reference\": \"\"\n },\n \"appearance\": {\n \"brandColor\": \"#ABED69\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#55ad39\",\n \"textColor\": \"#6F780B\",\n \"buttonTextColor\": \"#B4Ef4E\",\n \"borderRadius\": \"1px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2934f16b-948c-4896-9a2d-67011bd3b780", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7811408-66db-44f1-81a3-50f957352f06", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c563d2df-9d04-49e6-bdbd-4d79210fe00c", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cd96deb-6a36-4d0f-9464-97c58e2843f3", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6013b142-ba86-4dd3-982e-8ac39a2338c3", "name": "Avançar etapa da sessão", "request": { "name": "Avançar etapa da sessão", "description": { "content": "Avança a sessão de assinatura através de suas etapas. Suporta as ações:\naccept, verify_otp, resend_otp, start_liveness, complete_liveness,\nprepare_signing, complete_signing. Auto-finaliza na última etapa.\n\nAutenticação via embedToken (clientSecret).\n", "type": "text/plain" }, "url": { "path": [ "v1", "signing-sessions", ":sessionId", "advance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "sessionId", "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"complete_signing\",\n \"cpfCnpj\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"\",\n \"deviceInfo\": {\n \"screenWidth\": \"\",\n \"screenHeight\": \"\",\n \"language\": \"\",\n \"platform\": \"\",\n \"touchPoints\": \"\"\n },\n \"otpCode\": \"\",\n \"otpChannel\": \"email\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"sandboxBrightness\": \"\",\n \"sandboxSharpness\": \"\",\n \"sandboxLivenessConfidence\": \"\",\n \"sandboxSimilarity\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"GPS\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "6c3efb1e-b467-4b09-bdbc-0efc06518c05", "name": "Etapa avançada com sucesso.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "advance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"complete_signing\",\n \"cpfCnpj\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"\",\n \"deviceInfo\": {\n \"screenWidth\": \"\",\n \"screenHeight\": \"\",\n \"language\": \"\",\n \"platform\": \"\",\n \"touchPoints\": \"\"\n },\n \"otpCode\": \"\",\n \"otpChannel\": \"email\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"sandboxBrightness\": \"\",\n \"sandboxSharpness\": \"\",\n \"sandboxLivenessConfidence\": \"\",\n \"sandboxSimilarity\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"GPS\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"sessionId\": \"\",\n \"status\": \"CANCELLED\",\n \"currentStep\": {\n \"stepId\": \"\",\n \"type\": \"\",\n \"status\": \"\"\n },\n \"nextStep\": {\n \"stepId\": \"\",\n \"type\": \"\"\n },\n \"evidenceId\": \"\",\n \"redirectUrl\": \"\",\n \"completedAt\": \"\",\n \"hostedUrl\": \"\",\n \"livenessSessionId\": \"\",\n \"signatureRequestId\": \"\",\n \"hashToSign\": \"\",\n \"hashAlgorithm\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sandbox\": {\n \"otpCode\": \"\",\n \"autoPass\": \"\"\n },\n \"errorCode\": \"\",\n \"errorDetail\": \"\",\n \"retryable\": \"\",\n \"fallback\": {\n \"triggered\": \"\",\n \"reason\": \"\",\n \"nextStepType\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ad5e3546-6994-4e69-8eed-acc7e104d509", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "advance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"complete_signing\",\n \"cpfCnpj\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"\",\n \"deviceInfo\": {\n \"screenWidth\": \"\",\n \"screenHeight\": \"\",\n \"language\": \"\",\n \"platform\": \"\",\n \"touchPoints\": \"\"\n },\n \"otpCode\": \"\",\n \"otpChannel\": \"email\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"sandboxBrightness\": \"\",\n \"sandboxSharpness\": \"\",\n \"sandboxLivenessConfidence\": \"\",\n \"sandboxSimilarity\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"GPS\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e3424cf-5d88-4b0b-8ed1-bc3b2ae75a0c", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "advance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"complete_signing\",\n \"cpfCnpj\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"\",\n \"deviceInfo\": {\n \"screenWidth\": \"\",\n \"screenHeight\": \"\",\n \"language\": \"\",\n \"platform\": \"\",\n \"touchPoints\": \"\"\n },\n \"otpCode\": \"\",\n \"otpChannel\": \"email\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"sandboxBrightness\": \"\",\n \"sandboxSharpness\": \"\",\n \"sandboxLivenessConfidence\": \"\",\n \"sandboxSimilarity\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"GPS\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d3f54d5-eb0b-48ad-baab-39d197ce1fe5", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "advance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"complete_signing\",\n \"cpfCnpj\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"\",\n \"deviceInfo\": {\n \"screenWidth\": \"\",\n \"screenHeight\": \"\",\n \"language\": \"\",\n \"platform\": \"\",\n \"touchPoints\": \"\"\n },\n \"otpCode\": \"\",\n \"otpChannel\": \"email\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"sandboxBrightness\": \"\",\n \"sandboxSharpness\": \"\",\n \"sandboxLivenessConfidence\": \"\",\n \"sandboxSimilarity\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"GPS\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f28461f-5182-40ac-baff-23276d145221", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "advance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"complete_signing\",\n \"cpfCnpj\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"\",\n \"deviceInfo\": {\n \"screenWidth\": \"\",\n \"screenHeight\": \"\",\n \"language\": \"\",\n \"platform\": \"\",\n \"touchPoints\": \"\"\n },\n \"otpCode\": \"\",\n \"otpChannel\": \"email\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"sandboxBrightness\": \"\",\n \"sandboxSharpness\": \"\",\n \"sandboxLivenessConfidence\": \"\",\n \"sandboxSimilarity\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"GPS\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "baa61066-a2ee-4190-8e95-50a1feb98ce7", "name": "Limite de requisições excedido.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "advance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"complete_signing\",\n \"cpfCnpj\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"\",\n \"deviceInfo\": {\n \"screenWidth\": \"\",\n \"screenHeight\": \"\",\n \"language\": \"\",\n \"platform\": \"\",\n \"touchPoints\": \"\"\n },\n \"otpCode\": \"\",\n \"otpChannel\": \"email\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"sandboxBrightness\": \"\",\n \"sandboxSharpness\": \"\",\n \"sandboxLivenessConfidence\": \"\",\n \"sandboxSimilarity\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"GPS\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de tentar novamente.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80ac4217-2699-4248-972b-6c598e2f7f58", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "advance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"complete_signing\",\n \"cpfCnpj\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"\",\n \"deviceInfo\": {\n \"screenWidth\": \"\",\n \"screenHeight\": \"\",\n \"language\": \"\",\n \"platform\": \"\",\n \"touchPoints\": \"\"\n },\n \"otpCode\": \"\",\n \"otpChannel\": \"email\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"sandboxBrightness\": \"\",\n \"sandboxSharpness\": \"\",\n \"sandboxLivenessConfidence\": \"\",\n \"sandboxSimilarity\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"GPS\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2d66ebf5-a6a5-4b81-bf28-1bcff490f124", "name": "Serviço temporariamente indisponível.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "advance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"action\": \"complete_signing\",\n \"cpfCnpj\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"\",\n \"deviceInfo\": {\n \"screenWidth\": \"\",\n \"screenHeight\": \"\",\n \"language\": \"\",\n \"platform\": \"\",\n \"touchPoints\": \"\"\n },\n \"otpCode\": \"\",\n \"otpChannel\": \"email\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"sandboxBrightness\": \"\",\n \"sandboxSharpness\": \"\",\n \"sandboxLivenessConfidence\": \"\",\n \"sandboxSimilarity\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"GPS\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de tentar novamente.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "77c93aaf-e2ef-4ee1-a84a-37e87983e938", "name": "Consultar status da sessão (polling leve)", "request": { "name": "Consultar status da sessão (polling leve)", "description": { "content": "Endpoint leve para polling de status da sessão. Retorna apenas sessionId,\ntransactionId, status, completedAt e evidenceId.\n\nRequer scope `transactions:read`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "signing-sessions", ":sessionId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "sessionId", "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "3c518e10-7295-45e8-9d6c-a362c82b1f16", "name": "Status da sessão retornado com sucesso.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"sessionId\": \"\",\n \"transactionId\": \"\",\n \"status\": \"FAILED\",\n \"completedAt\": \"\",\n \"evidenceId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4809e253-34f8-4fb4-84c7-b2f7652cfbba", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6383eab7-e81f-4f79-86ba-e86919b658da", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "236d54b9-456b-4c30-887e-ccd24cebdfad", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "status" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c19ac444-d3ea-4c8a-83c5-95ce739f38c8", "name": "Cancelar sessão de assinatura", "request": { "name": "Cancelar sessão de assinatura", "description": { "content": "Cancela uma sessão de assinatura ativa. Apenas sessões com status ACTIVE podem\nser canceladas. O cancelamento cascateia para a transação subjacente.\n\nRequer scope `transactions:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "signing-sessions", ":sessionId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "sessionId", "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "d09ed277-9ccf-4f0d-8c07-90f3f159ac1f", "name": "Sessão cancelada com sucesso.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"sessionId\": \"\",\n \"transactionId\": \"\",\n \"status\": \"COMPLETED\",\n \"cancelledAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63475399-b74d-4f3c-a068-20958fb34437", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e6c582e4-76c3-48dd-8936-6abfd46c3a07", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f83d2cc5-adf2-48d9-9915-1a84802188c3", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b094c1d1-d98e-4d1c-8de5-199632e4766f", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f061ba63-64b0-44cd-beee-7b027a3ee3fd", "name": "Reenviar convite de assinatura", "request": { "name": "Reenviar convite de assinatura", "description": { "content": "Reenvia o convite de uma sessão `ACTIVE` — por exemplo, quando o original\ncaiu no spam ou se perdeu. Gera um link novo (novo `clientSecret`); o link\nanterior continua válido até a sessão expirar.\n\nSem corpo, reenvia pelos canais com que o signatário foi criado\n(`deliverVia`); sessões sem canais gravados reenviam por e-mail. Informe\n`deliverVia` no corpo para escolher outros canais nesta chamada.\n\nLimitado a um reenvio a cada 60 segundos por sessão: dentro desse intervalo\na chamada retorna `409` com o tempo restante. Também retorna `409` quando a\nsessão não está `ACTIVE`, ou quando o e-mail é pedido e a sessão não tem\ne-mail do signatário.\n\nReenvios por WhatsApp e Telegram consomem a cota de mensagens do tenant:\nesgotada, a chamada retorna **429** antes de gerar link ou enviar qualquer\nmensagem.\n\nRequer scope `transactions:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "sessionId", "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "f1fdfce4-2f7b-4f24-82d3-91dd47a0e1d9", "name": "Convite reenviado.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"sessionId\": \"\",\n \"transactionId\": \"\",\n \"resentAt\": \"\",\n \"to\": \"\",\n \"whatsappInviteSent\": \"\",\n \"telegramInviteSent\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39882fdd-deb0-4022-afd7-7e049e4abfd6", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0be61549-1f4f-48f1-8690-c75da8a9bb38", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "571e4724-0cef-4faa-8fc4-ba5d517e388c", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "160ebe43-0605-4d35-a021-e68242850f4e", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98348d0a-3434-4d5f-8ccf-617190e69220", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c09a31e-ca33-45b5-81f1-dee069082fdb", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.\n\nInclui o perfil de política não autorizado para o tenant. As rotas de criação\n(`/v1/transactions`, `/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`)\nverificam a mesma regra, antes de cota, convite e gravação — a recusa não consome\ndocumento. As flags envolvidas são `featureFlags.customPolicyEnabled` (perfil `CUSTOM`),\n`serpro.enabled` (perfis SERPRO), `featureFlags.documentExtractionEnabled` (fallback por\ndocumento; `BIOMETRIC_SERPRO_AUTO_FALLBACK` exige as duas últimas) e\n`featureFlags.biometricRequired`. O remédio é habilitar a flag para o tenant.\n\n`signer.cpf` e `signer.birthDate`, exigidos pelos perfis SERPRO, são validados como\n**400** e não aqui: requisição malformada, corrigível na mesma chamada.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f645dc80-920e-4779-83f2-88c056fd0c2f", "name": "Limite de requisições excedido.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de tentar novamente.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6af9630d-2fc5-4811-93ef-6fc79d8e3bf5", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1d9f17e-33be-401c-9bd8-08b74ffcfa3c", "name": "Serviço temporariamente indisponível.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-invite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de tentar novamente.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "abbd32d9-c89e-4664-bddc-81f1a0624f6f", "name": "Gerar novo link de assinatura", "request": { "name": "Gerar novo link de assinatura", "description": { "content": "Gera uma nova URL de assinatura para uma sessão existente.\n\nO link de assinatura é de **uso único**: depois que o signatário conclui — ou\nse o token embutido é consumido de outra forma — reabrir a mesma URL retorna\n`401 Embed token has been consumed`. Use este endpoint para emitir um link\nnovo sem criar outra transação e **sem consumir cota**.\n\nVale para sessões avulsas e para sessões de envelope, indistintamente.\n\n**Somente sessões `ACTIVE`.** Uma sessão já concluída ou cancelada responde\n`409 Session cannot be linked in status: ` — um link para uma sessão\nencerrada não autenticaria nada. Para dar acesso ao documento assinado use\n`POST /v1/envelopes/{envelopeId}/combined-stamp` (envelope) ou\n`GET /v1/transactions/{transactionId}/download` (transação avulsa).\n\nA URL herda o prazo da sessão original: `expiresAt` não é estendido.\n\nRequer scope `transactions:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "signing-sessions", ":sessionId", "link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "sessionId", "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "f04cf19e-bb76-498c-a702-4a110f30b6bd", "name": "Novo link gerado com sucesso.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"sessionId\": \"\",\n \"transactionId\": \"\",\n \"url\": \"\",\n \"expiresAt\": \"\",\n \"expiresIn\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab00faac-2907-485c-9ef4-511037770cde", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7490d0c-a96d-4df0-a0b3-cb119b984822", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a5eb433-5800-49bc-a049-f1f37ecb10bc", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "07a62318-c45a-46da-8fbc-aeca893b55ce", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "link" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "72f58e7b-a849-4a52-a4ff-bf304538c72f", "name": "Reenviar código OTP da sessão", "request": { "name": "Reenviar código OTP da sessão", "description": { "content": "Reenvia o desafio OTP para a sessão de assinatura atual.\n\nOpcionalmente, informe `channel` para reenviar por um canal diferente\n(e-mail, SMS, WhatsApp ou Telegram). O canal só é aceito quando a sessão foi\ncriada com `signer.otpChannelSelectable`; caso contrário a requisição\nretorna 400.\n\nLimitado a um reenvio a cada 60 segundos por sessão. Dentro desse\nintervalo a chamada retorna `409` com o tempo restante — o endpoint é\nautenticado pelo signatário, e um reenvio por SMS, WhatsApp ou Telegram\nGateway é uma mensagem tarifada. Por WhatsApp e Telegram Gateway, o reenvio\nconsome a cota de mensagens do tenant (429 quando esgotada).\n\nAutenticação via embedToken (clientSecret).\n", "type": "text/plain" }, "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-otp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "sessionId", "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"channel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "58c90504-aa75-42d8-9479-75f743b0c511", "name": "OTP reenviado com sucesso.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-otp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"channel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"sessionId\": \"\",\n \"status\": \"CANCELLED\",\n \"currentStep\": {\n \"stepId\": \"\",\n \"type\": \"\",\n \"status\": \"\"\n },\n \"nextStep\": {\n \"stepId\": \"\",\n \"type\": \"\"\n },\n \"evidenceId\": \"\",\n \"redirectUrl\": \"\",\n \"completedAt\": \"\",\n \"hostedUrl\": \"\",\n \"livenessSessionId\": \"\",\n \"signatureRequestId\": \"\",\n \"hashToSign\": \"\",\n \"hashAlgorithm\": \"\",\n \"signatureAlgorithm\": \"\",\n \"sandbox\": {\n \"otpCode\": \"\",\n \"autoPass\": \"\"\n },\n \"errorCode\": \"\",\n \"errorDetail\": \"\",\n \"retryable\": \"\",\n \"fallback\": {\n \"triggered\": \"\",\n \"reason\": \"\",\n \"nextStepType\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9935edf2-f5f1-4695-8f81-d78b16420a9a", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-otp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"channel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c223c3e6-e512-4cf6-9757-9fcdbefcf2e8", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-otp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"channel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "143f14e2-bd81-4e32-9033-24fc77619832", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-otp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"channel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef485c75-dfe2-4b4a-9a06-b39e03dbaded", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-otp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"channel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a269bca1-c395-48d4-8f59-586d32f428ef", "name": "Limite de requisições excedido.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-otp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"channel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de tentar novamente.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "751226ae-cbe8-42ee-a494-80bc86ab2f5c", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-otp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"channel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "715584ab-e851-44cc-8b4d-d36ddf8c4b8c", "name": "Serviço temporariamente indisponível.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "resend-otp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"channel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de tentar novamente.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "11. Envelopes", "description": "Crie envelopes para assinatura com múltiplos signatários, adicione sessões e gere carimbo combinado.", "item": [ { "id": "6499462f-e8bb-4f0c-b59c-a766ba9c0f79", "name": "Criar envelope para múltiplos signatários", "request": { "name": "Criar envelope para múltiplos signatários", "description": { "content": "Cria um envelope que agrupa sessões de assinatura sobre o mesmo documento.\nSuporta modo PARALLEL (todos assinam simultaneamente) ou SEQUENTIAL (em ordem).\n\nCom `signerConfidentiality`, nenhum signatário vê os dados dos demais\n(requer habilitação do tenant; ver o campo).\n\nRequer scope `transactions:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signingMode\": \"PARALLEL\",\n \"totalSigners\": \"\",\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 4320,\n \"appearance\": {\n \"brandColor\": \"#55f600\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#Ecb0Aa\",\n \"textColor\": \"#cdbDfD\",\n \"buttonTextColor\": \"#fF3c59\",\n \"borderRadius\": \"80026563px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"signerConfidentiality\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "b98baf2c-93e9-4204-abd1-4c7452dbd4c9", "name": "Envelope criado com sucesso.", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signingMode\": \"PARALLEL\",\n \"totalSigners\": \"\",\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 4320,\n \"appearance\": {\n \"brandColor\": \"#55f600\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#Ecb0Aa\",\n \"textColor\": \"#cdbDfD\",\n \"buttonTextColor\": \"#fF3c59\",\n \"borderRadius\": \"80026563px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"signerConfidentiality\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "URL do recurso criado.", "type": "text/plain" }, "key": "Location", "value": "" } ], "body": "{\n \"envelopeId\": \"\",\n \"status\": \"EXPIRED\",\n \"signingMode\": \"PARALLEL\",\n \"totalSigners\": \"\",\n \"documentHash\": \"\",\n \"signerConfidentiality\": \"\",\n \"createdAt\": \"\",\n \"expiresAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a2ffe3e-f26a-4359-99c0-2fbb233a14bd", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signingMode\": \"PARALLEL\",\n \"totalSigners\": \"\",\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 4320,\n \"appearance\": {\n \"brandColor\": \"#55f600\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#Ecb0Aa\",\n \"textColor\": \"#cdbDfD\",\n \"buttonTextColor\": \"#fF3c59\",\n \"borderRadius\": \"80026563px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"signerConfidentiality\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2cbdd135-b3e1-49bb-be97-43fb9ebd7c32", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signingMode\": \"PARALLEL\",\n \"totalSigners\": \"\",\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 4320,\n \"appearance\": {\n \"brandColor\": \"#55f600\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#Ecb0Aa\",\n \"textColor\": \"#cdbDfD\",\n \"buttonTextColor\": \"#fF3c59\",\n \"borderRadius\": \"80026563px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"signerConfidentiality\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c3b4d1bb-f3e4-4b54-97c6-3616d3321630", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signingMode\": \"PARALLEL\",\n \"totalSigners\": \"\",\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 4320,\n \"appearance\": {\n \"brandColor\": \"#55f600\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#Ecb0Aa\",\n \"textColor\": \"#cdbDfD\",\n \"buttonTextColor\": \"#fF3c59\",\n \"borderRadius\": \"80026563px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"signerConfidentiality\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c92f6c0-178a-4efd-b77f-4ac7c02fc387", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signingMode\": \"PARALLEL\",\n \"totalSigners\": \"\",\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 4320,\n \"appearance\": {\n \"brandColor\": \"#55f600\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#Ecb0Aa\",\n \"textColor\": \"#cdbDfD\",\n \"buttonTextColor\": \"#fF3c59\",\n \"borderRadius\": \"80026563px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"signerConfidentiality\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb7a692e-506e-4b0f-ba96-e473dacf4427", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.\n\nInclui o perfil de política não autorizado para o tenant. As rotas de criação\n(`/v1/transactions`, `/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`)\nverificam a mesma regra, antes de cota, convite e gravação — a recusa não consome\ndocumento. As flags envolvidas são `featureFlags.customPolicyEnabled` (perfil `CUSTOM`),\n`serpro.enabled` (perfis SERPRO), `featureFlags.documentExtractionEnabled` (fallback por\ndocumento; `BIOMETRIC_SERPRO_AUTO_FALLBACK` exige as duas últimas) e\n`featureFlags.biometricRequired`. O remédio é habilitar a flag para o tenant.\n\n`signer.cpf` e `signer.birthDate`, exigidos pelos perfis SERPRO, são validados como\n**400** e não aqui: requisição malformada, corrigível na mesma chamada.", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signingMode\": \"PARALLEL\",\n \"totalSigners\": \"\",\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 4320,\n \"appearance\": {\n \"brandColor\": \"#55f600\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#Ecb0Aa\",\n \"textColor\": \"#cdbDfD\",\n \"buttonTextColor\": \"#fF3c59\",\n \"borderRadius\": \"80026563px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"signerConfidentiality\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3dd6066-49b7-487d-86e9-26a77b6be8fd", "name": "Limite de requisições excedido.", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signingMode\": \"PARALLEL\",\n \"totalSigners\": \"\",\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 4320,\n \"appearance\": {\n \"brandColor\": \"#55f600\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#Ecb0Aa\",\n \"textColor\": \"#cdbDfD\",\n \"buttonTextColor\": \"#fF3c59\",\n \"borderRadius\": \"80026563px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"signerConfidentiality\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de tentar novamente.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "37a11605-3caa-4e8c-b05c-b77af03d52ca", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signingMode\": \"PARALLEL\",\n \"totalSigners\": \"\",\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 4320,\n \"appearance\": {\n \"brandColor\": \"#55f600\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#Ecb0Aa\",\n \"textColor\": \"#cdbDfD\",\n \"buttonTextColor\": \"#fF3c59\",\n \"borderRadius\": \"80026563px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n },\n \"signerConfidentiality\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1fa5d3f9-c440-43ff-b631-b826aeb1d4b0", "name": "Consultar detalhes do envelope", "request": { "name": "Consultar detalhes do envelope", "description": { "content": "Retorna os detalhes completos do envelope, incluindo resumo de cada sessão.\n\nRequer scope `transactions:read`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "envelopes", ":envelopeId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "envelopeId", "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "0eb4c514-9daf-4d7f-ab9e-22b1deb0786f", "name": "Detalhes do envelope retornados com sucesso.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"envelopeId\": \"\",\n \"status\": \"COMPLETED\",\n \"signingMode\": \"SEQUENTIAL\",\n \"totalSigners\": \"\",\n \"addedSessions\": \"\",\n \"completedSessions\": \"\",\n \"documentHash\": \"\",\n \"signerConfidentiality\": \"\",\n \"sessions\": [\n {\n \"sessionId\": \"\",\n \"transactionId\": \"\",\n \"signerIndex\": \"\",\n \"signerName\": \"\",\n \"status\": \"EXPIRED\",\n \"completedAt\": \"\",\n \"evidenceId\": \"\"\n },\n {\n \"sessionId\": \"\",\n \"transactionId\": \"\",\n \"signerIndex\": \"\",\n \"signerName\": \"\",\n \"status\": \"FAILED\",\n \"completedAt\": \"\",\n \"evidenceId\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"expiresAt\": \"\",\n \"combinedSignedPdfUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca649198-29aa-4b99-b01e-f83da59f193f", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2dfa1898-b9e5-4fa6-8143-95561954d825", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "562bcf55-f52f-4807-b38d-f070ce4bf7c6", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff98bb4c-338f-4166-9aa2-41bf35fae8ea", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ac07d94-578b-4189-affc-dc7d86f81fba", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f0548cb-7617-411f-a12e-36e04c9f4683", "name": "Adicionar sessão de signatário ao envelope", "request": { "name": "Adicionar sessão de signatário ao envelope", "description": { "content": "Adiciona uma sessão de assinatura para um signatário no envelope. Retorna a URL\ne clientSecret para integração. O link entregue àquele signatário é\n`{url}?cs={clientSecret}` — a `url` sozinha não abre.\n\nSuporta idempotência via header `X-Idempotency-Key`. Use uma chave\n**distinta por signatário** (o corpo muda a cada `signerIndex`): reenviar\na mesma chave devolve a resposta original, incluindo o `clientSecret` —\nque só é retornado nesta resposta e não pode ser recuperado depois.\n\nRequer scope `transactions:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "envelopes", ":envelopeId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "envelopeId", "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"policy\": {\n \"profile\": \"\"\n },\n \"signerIndex\": \"\",\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "42353e5a-a72b-4bee-a2e0-1f70bd5f6dac", "name": "Sessão de signatário adicionada com sucesso.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"policy\": {\n \"profile\": \"\"\n },\n \"signerIndex\": \"\",\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "URL do recurso criado.", "type": "text/plain" }, "key": "Location", "value": "" } ], "body": "{\n \"sessionId\": \"\",\n \"transactionId\": \"\",\n \"signerIndex\": \"\",\n \"status\": \"ACTIVE\",\n \"url\": \"\",\n \"clientSecret\": \"\",\n \"expiresAt\": \"\",\n \"inviteSent\": \"\",\n \"whatsappInviteSent\": \"\",\n \"telegramInviteSent\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f17d6a70-8dc7-4e4f-b187-894007c7ffc6", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"policy\": {\n \"profile\": \"\"\n },\n \"signerIndex\": \"\",\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c146cbe-01be-4ede-8be1-bf79933a008f", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"policy\": {\n \"profile\": \"\"\n },\n \"signerIndex\": \"\",\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b53ce871-2cad-4b62-a288-b3cb06349869", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"policy\": {\n \"profile\": \"\"\n },\n \"signerIndex\": \"\",\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30423b41-36f7-4e92-bccc-fe71f7fdd24e", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"policy\": {\n \"profile\": \"\"\n },\n \"signerIndex\": \"\",\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22b5cd33-8929-4cf0-8895-a131e9d72936", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"policy\": {\n \"profile\": \"\"\n },\n \"signerIndex\": \"\",\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4d5e800-b647-4e8c-81b9-e78da844206f", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.\n\nInclui o perfil de política não autorizado para o tenant. As rotas de criação\n(`/v1/transactions`, `/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`)\nverificam a mesma regra, antes de cota, convite e gravação — a recusa não consome\ndocumento. As flags envolvidas são `featureFlags.customPolicyEnabled` (perfil `CUSTOM`),\n`serpro.enabled` (perfis SERPRO), `featureFlags.documentExtractionEnabled` (fallback por\ndocumento; `BIOMETRIC_SERPRO_AUTO_FALLBACK` exige as duas últimas) e\n`featureFlags.biometricRequired`. O remédio é habilitar a flag para o tenant.\n\n`signer.cpf` e `signer.birthDate`, exigidos pelos perfis SERPRO, são validados como\n**400** e não aqui: requisição malformada, corrigível na mesma chamada.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"policy\": {\n \"profile\": \"\"\n },\n \"signerIndex\": \"\",\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7af91a67-88d1-4eb7-9762-61dc50b2e77b", "name": "Limite de requisições excedido.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"policy\": {\n \"profile\": \"\"\n },\n \"signerIndex\": \"\",\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de tentar novamente.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c327e98a-8b2d-4705-8171-7b1b9511514c", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"policy\": {\n \"profile\": \"\"\n },\n \"signerIndex\": \"\",\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f17d75ec-7dc5-4f0c-879d-e5521cd0b57d", "name": "Serviço temporariamente indisponível.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada. Reenviar a mesma\nchave com o mesmo corpo dentro de 24h devolve a resposta original, sem\nconsumir cota nem repetir efeitos (e-mails, webhooks). A mesma chave com\num corpo diferente responde `409`.\n\nA resposta repetida é a original byte a byte, incluindo os cabeçalhos\n`RateLimit-*` — eles refletem a cota no momento da chamada original, já\nque a repetição não consumiu nada.\n", "type": "text/plain" }, "key": "X-Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"policy\": {\n \"profile\": \"\"\n },\n \"signerIndex\": \"\",\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"deliverVia\": [\n \"whatsapp\",\n \"email\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de tentar novamente.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "da67297b-f9a3-42e8-9edb-da81e5e51db7", "name": "Gerar carimbo combinado do envelope", "request": { "name": "Gerar carimbo combinado do envelope", "description": { "content": "Gera ou recupera o documento com carimbo combinado de todas as assinaturas do envelope.\nDisponível somente após todas as sessões serem concluídas.\n\nCada chamada devolve uma URL assinada nova, válida por **1 hora**. Este é o\ncaminho para recuperar o PDF combinado quando o `combinedDownloadUrl` entregue\nno evento `ENVELOPE.ALL_SIGNED` já expirou.\n\nRequer scope `transactions:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "envelopes", ":envelopeId", "combined-stamp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "envelopeId", "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "960fa3ca-b524-48cf-b79d-b89a26b10508", "name": "Carimbo combinado gerado com sucesso.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "combined-stamp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"envelopeId\": \"\",\n \"downloadUrl\": \"\",\n \"expiresIn\": \"\",\n \"signerCount\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bd08ff7-4aa7-4408-92be-3ca991b0e1ff", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "combined-stamp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62e81365-22fb-432e-b010-6f9991995b50", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "combined-stamp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1b3b53d-f2be-4c1a-8153-f57d832fbc0f", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "combined-stamp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05b3623a-7ee8-45e6-858f-999851279dda", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "combined-stamp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2cc5e35-1559-41b5-8fe8-6e6cec64e951", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "combined-stamp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c0b0245-e94c-419e-b3d4-02d036c31507", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "combined-stamp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3e6e3f5d-4add-4b0c-84aa-cb3bca58ffa5", "name": "Cancelar envelope", "request": { "name": "Cancelar envelope", "description": { "content": "Cancela um envelope e todas as suas sessões de assinatura ainda pendentes.\n\nSessões **já concluídas são preservadas** — a resposta devolve\n`preservedSignedCount` para que assinaturas legítimas nunca sejam descartadas\njunto com o cancelamento. Chamar novamente um envelope já cancelado devolve\n`200` com `alreadyCancelled: true` (idempotente).\n\nRequer scope `transactions:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "envelopes", ":envelopeId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "envelopeId", "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "13125c57-03c8-4065-b4a4-0acdbcb3b10d", "name": "Envelope cancelado com sucesso.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"envelopeId\": \"\",\n \"status\": \"CANCELLED\",\n \"cancelledCount\": \"\",\n \"preservedSignedCount\": \"\",\n \"cancelledSessions\": [\n {\n \"sessionId\": \"\",\n \"transactionId\": \"\"\n },\n {\n \"sessionId\": \"\",\n \"transactionId\": \"\"\n }\n ],\n \"alreadyCancelled\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4dea4bd-b2cb-40c6-82f6-ca63fab6a7ab", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca95bb06-0c74-4be9-a28d-dd38c3575eeb", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3bb3633-edec-4acc-9bfe-75d4ccf0db3e", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":envelopeId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único do envelope.", "type": "text/plain" }, "type": "any", "value": "", "key": "envelopeId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "12. Grupos de Documentos", "description": "Geração de carimbo combinado para grupos de documentos.", "item": [ { "id": "940bb34f-31a7-4eb6-8c1f-f1e8d0624637", "name": "Gerar carimbo combinado do grupo", "request": { "name": "Gerar carimbo combinado do grupo", "description": { "content": "Gera o documento com carimbo visual combinado para todas as assinaturas do grupo de documentos (PDF: carimbo visual; outros formatos: .p7s combinado).\nRetorna URL pré-assinada para download do PDF gerado.\n\nRequer scope `transactions:write`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "document-groups", ":groupId", "combined-stamp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "groupId", "disabled": false, "description": { "content": "(Required) Identificador do grupo de documentos.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "9f90f1f2-9f26-4906-9347-a40c058f4bd3", "name": "Carimbo combinado gerado com sucesso.", "originalRequest": { "url": { "path": [ "v1", "document-groups", ":groupId", "combined-stamp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador do grupo de documentos.", "type": "text/plain" }, "type": "any", "value": "", "key": "groupId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"groupId\": \"\",\n \"signerCount\": \"\",\n \"downloadUrl\": \"\",\n \"expiresIn\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "45da4589-5642-4f1c-b332-616206a8ff34", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "document-groups", ":groupId", "combined-stamp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador do grupo de documentos.", "type": "text/plain" }, "type": "any", "value": "", "key": "groupId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdd033cc-493b-4756-8cce-1cc5ac2b3567", "name": "Permissões insuficientes para a operação solicitada.\n\nInclui `purpose: \"ACTION_AUTHENTICATION\"` sem `featureFlags.trustSessionsEnabled`. A\nverificação é pelo `purpose`, não pela rota: vale em `/v1/transactions`,\n`/v1/signing-sessions` e `/v1/envelopes/{envelopeId}/sessions`, além de `/v1/trust-sessions`.\nO remédio é habilitar a flag para o tenant e provisionar a cota `monthlyTrustSessions`.", "originalRequest": { "url": { "path": [ "v1", "document-groups", ":groupId", "combined-stamp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador do grupo de documentos.", "type": "text/plain" }, "type": "any", "value": "", "key": "groupId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d777ea47-e05e-4456-ad16-a5bcf7d5ff5f", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "document-groups", ":groupId", "combined-stamp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador do grupo de documentos.", "type": "text/plain" }, "type": "any", "value": "", "key": "groupId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "833d5d8c-9dcc-48dd-ab8e-92c5781988ed", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "document-groups", ":groupId", "combined-stamp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador do grupo de documentos.", "type": "text/plain" }, "type": "any", "value": "", "key": "groupId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a1e9be7-8846-477d-85a1-83df54bcc75e", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "document-groups", ":groupId", "combined-stamp" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador do grupo de documentos.", "type": "text/plain" }, "type": "any", "value": "", "key": "groupId" } ] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Health", "description": "Verificação de saúde da API.", "item": [ { "id": "f380028a-8ad3-4a1d-bb72-bb48543e4696", "name": "Verificar saúde da API", "request": { "name": "Verificar saúde da API", "description": { "content": "Retorna o status de saúde da API e de seus componentes internos (DynamoDB, S3, KMS, mTLS Truststore).\nRetorna `200` se todos os componentes estão operacionais, `503` se algum está indisponível.\n", "type": "text/plain" }, "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c5ec0ae9-04e8-4677-b452-e42537209da0", "name": "API saudável — todos os componentes operacionais.", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"status\": \"unhealthy\",\n \"timestamp\": \"\",\n \"service\": \"\",\n \"components\": {\n \"dynamodb\": {\n \"status\": \"operational\",\n \"latencyMs\": \"\"\n },\n \"s3\": {\n \"status\": \"down\",\n \"latencyMs\": \"\"\n },\n \"kms\": {\n \"status\": \"down\",\n \"latencyMs\": \"\"\n },\n \"mtlsTruststore\": {\n \"status\": \"down\",\n \"latencyMs\": \"\"\n }\n },\n \"latencyMs\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c203398-e5d4-40c9-8cdf-b5ce89ba593c", "name": "Limite de requisições excedido.", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de tentar novamente.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4745379c-0db7-4c31-a878-f4f02e434a3d", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a46530ed-b581-4336-b5d7-cb90c57df8c1", "name": "Serviço temporariamente indisponível.", "originalRequest": { "url": { "path": [ "health" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de tentar novamente.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5335f44e-e6e7-4247-b799-eedec4096f00", "name": "Consultar histórico de saúde", "request": { "name": "Consultar histórico de saúde", "description": { "content": "Retorna métricas históricas de disponibilidade da API, incluindo uptime por componente,\nincidentes e a última verificação realizada.\n", "type": "text/plain" }, "url": { "path": [ "health", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Período de consulta do histórico. (This can only be one of 24h,7d,30d)", "type": "text/plain" }, "key": "period", "value": "24h" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "205f5957-b2ac-4030-8e8e-1ff5ce39b79c", "name": "Histórico de saúde retornado com sucesso.", "originalRequest": { "url": { "path": [ "health", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Período de consulta do histórico. (This can only be one of 24h,7d,30d)", "type": "text/plain" }, "key": "period", "value": "24h" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"period\": \"30d\",\n \"from\": \"\",\n \"to\": \"\",\n \"totalChecks\": \"\",\n \"uptime\": {\n \"overall\": \"\",\n \"dynamodb\": \"\",\n \"s3\": \"\",\n \"kms\": \"\",\n \"mtlsTruststore\": \"\"\n },\n \"incidents\": [\n {\n \"startedAt\": \"\",\n \"affectedComponents\": [\n \"\",\n \"\"\n ],\n \"endedAt\": \"\",\n \"durationMinutes\": \"\"\n },\n {\n \"startedAt\": \"\",\n \"affectedComponents\": [\n \"\",\n \"\"\n ],\n \"endedAt\": \"\",\n \"durationMinutes\": \"\"\n }\n ],\n \"latestCheck\": {\n \"overallStatus\": \"\",\n \"components\": {\n \"dynamodb\": {\n \"status\": \"operational\",\n \"latencyMs\": \"\"\n },\n \"s3\": {\n \"status\": \"operational\",\n \"latencyMs\": \"\"\n },\n \"kms\": {\n \"status\": \"operational\",\n \"latencyMs\": \"\"\n },\n \"mtlsTruststore\": {\n \"status\": \"down\",\n \"latencyMs\": \"\"\n }\n },\n \"checkedAt\": \"\",\n \"totalLatencyMs\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1964970b-7d4c-4db5-acb9-0b7d7e934227", "name": "Limite de requisições excedido.", "originalRequest": { "url": { "path": [ "health", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Período de consulta do histórico. (This can only be one of 24h,7d,30d)", "type": "text/plain" }, "key": "period", "value": "24h" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/problem+json" }, { "disabled": false, "description": { "content": "Segundos a aguardar antes de tentar novamente.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de3967f1-6d61-4b2c-bc61-424850d039de", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "health", "history" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Período de consulta do histórico. (This can only be one of 24h,7d,30d)", "type": "text/plain" }, "key": "period", "value": "24h" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"retryable\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "bearer", "bearer": [ { "type": "any", "value": "{{access_token}}", "key": "token" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.signdocs.com.br" } ], "info": { "_postman_id": "7b157d2d-3a54-4dca-801b-34606a85dff6", "name": "SignDocs Brasil External API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "API B2B para assinatura eletrônica com biometria facial, OTP, clickwrap e certificado digital ICP-Brasil.\n\n## Fluxo recomendado\n\nExecute as requisições na ordem das pastas para um fluxo completo de assinatura:\n\n1. **Autenticação** → POST /oauth2/token (o access_token é salvo automaticamente)\n2. **Transações** → POST /v1/transactions (o transactionId é salvo automaticamente)\n3. **Documentos** → Upload do PDF via base64 ou URL pré-assinada\n4. **Etapas** → Liste e complete cada etapa (OTP, biometria, clickwrap)\n5. **Assinatura Digital** → Prepare e conclua a assinatura ICP-Brasil A1\n6. **Finalizar** → POST .../finalize gera o Evidence Pack (evidenceId salvo automaticamente)\n7. **Verificação** → Valide a evidência pela rota pública\n\n## Variáveis automáticas\n\nOs scripts de teste extraem automaticamente:\n- `access_token` — do POST /oauth2/token\n- `transactionId` — do POST /v1/transactions\n- `stepId` — do GET .../steps (primeiro passo PENDING)\n- `evidenceId` — do POST .../finalize\n- `webhookId` — do POST /v1/webhooks\n\nBasta configurar `client_id` e `client_secret` no environment e executar em sequência.\n\n## Ambientes\n\n| Ambiente | URL |\n|----------|-----|\n| Produção | `https://api.signdocs.com.br` |\n| Homologação | `https://api-hml.signdocs.com.br` |\n\n## Erros\n\nTodas as respostas de erro seguem o formato RFC 7807 Problem Details (`application/problem+json`).\n\nContact Support:\n Name: SignDocs Brasil API Support\n Email: administrativo@signdocs.com.br", "type": "text/plain" } } }