{ "item": [ { "name": "1. Autenticação", "description": "Obtenha o token de acesso via OAuth2 client_credentials.", "item": [ { "id": "2905b245-a814-4fb8-a697-c556429745ec", "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": "6419ba91-4529-496a-a8ed-bedae531647a", "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": "3e113d4c-e7fc-4ee5-bfa3-19c6b43f83f0", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a356ba22-db7b-4439-b1e5-1bfcabfa99b1", "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}", "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": "1f0356fe-979c-4376-af6d-861a26d6b0e7", "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.", "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": "d905f1c0-59dd-4d1e-8640-06736e0a22b7", "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.", "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\": \"BIOMETRIC\",\n \"customSteps\": [\n \"OTP_VERIFY\",\n \"BIOMETRIC_MATCH\"\n ]\n },\n \"signer\": {\n \"cpf\": \"string\"\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 \"documentGroupId\": \"\",\n \"signerIndex\": \"\",\n \"totalSigners\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\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\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"CUSTOM\",\n \"customSteps\": [\n \"DIGITAL_SIGN_A1\",\n \"BIOMETRIC_MATCH\"\n ]\n },\n \"steps\": [\n {\n \"stepId\": \"\",\n \"type\": \"BIOMETRIC_LIVENESS\",\n \"status\": \"COMPLETED\",\n \"order\": \"\"\n },\n {\n \"stepId\": \"\",\n \"type\": \"CLICK_ACCEPT\",\n \"status\": \"STARTED\",\n \"order\": \"\"\n }\n ],\n \"userExternalId\": \"\",\n \"createdAt\": \"\",\n \"documentHash\": \"\",\n \"expiresAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4632ec0c-e212-4c49-9d44-87b7b2b1ed5f", "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.", "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\": \"BIOMETRIC\",\n \"customSteps\": [\n \"OTP_VERIFY\",\n \"BIOMETRIC_MATCH\"\n ]\n },\n \"signer\": {\n \"cpf\": \"string\"\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 \"documentGroupId\": \"\",\n \"signerIndex\": \"\",\n \"totalSigners\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2061ff7a-159e-4334-ba60-e1b486e42cd2", "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.", "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\": \"BIOMETRIC\",\n \"customSteps\": [\n \"OTP_VERIFY\",\n \"BIOMETRIC_MATCH\"\n ]\n },\n \"signer\": {\n \"cpf\": \"string\"\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 \"documentGroupId\": \"\",\n \"signerIndex\": \"\",\n \"totalSigners\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6f81ce3-25dc-4c88-a309-849a098c7bce", "name": "Permissões insuficientes para a operação solicitada.", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada.", "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\": \"BIOMETRIC\",\n \"customSteps\": [\n \"OTP_VERIFY\",\n \"BIOMETRIC_MATCH\"\n ]\n },\n \"signer\": {\n \"cpf\": \"string\"\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 \"documentGroupId\": \"\",\n \"signerIndex\": \"\",\n \"totalSigners\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "307dfc02-0624-4906-ab07-5d0d4349cabb", "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.", "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\": \"BIOMETRIC\",\n \"customSteps\": [\n \"OTP_VERIFY\",\n \"BIOMETRIC_MATCH\"\n ]\n },\n \"signer\": {\n \"cpf\": \"string\"\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 \"documentGroupId\": \"\",\n \"signerIndex\": \"\",\n \"totalSigners\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "132fcbba-2679-4335-b8cd-a4f2a2321dfd", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.", "originalRequest": { "url": { "path": [ "v1", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada.", "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\": \"BIOMETRIC\",\n \"customSteps\": [\n \"OTP_VERIFY\",\n \"BIOMETRIC_MATCH\"\n ]\n },\n \"signer\": {\n \"cpf\": \"string\"\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 \"documentGroupId\": \"\",\n \"signerIndex\": \"\",\n \"totalSigners\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2999f668-9247-4828-98b9-064ac2b3c08a", "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.", "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\": \"BIOMETRIC\",\n \"customSteps\": [\n \"OTP_VERIFY\",\n \"BIOMETRIC_MATCH\"\n ]\n },\n \"signer\": {\n \"cpf\": \"string\"\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 \"documentGroupId\": \"\",\n \"signerIndex\": \"\",\n \"totalSigners\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a822e60-0f22-4f61-9341-685e59232ae1", "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.", "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\": \"BIOMETRIC\",\n \"customSteps\": [\n \"OTP_VERIFY\",\n \"BIOMETRIC_MATCH\"\n ]\n },\n \"signer\": {\n \"cpf\": \"string\"\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 \"documentGroupId\": \"\",\n \"signerIndex\": \"\",\n \"totalSigners\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\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}", "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": "3cc84d2c-5ca6-4cc2-ab9a-9f30548f76a7", "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": "CANCELLED" }, { "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": "8bf9622f-641a-42e8-8265-cbe7d97d43d6", "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": "CANCELLED" }, { "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\": \"EXPIRED\",\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"BIOMETRIC_PLUS_OTP\",\n \"customSteps\": [\n \"BIOMETRIC_LIVENESS\",\n \"DIGITAL_SIGN_A1\"\n ]\n },\n \"userExternalId\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"documentHash\": \"\",\n \"documentGroupId\": \"\"\n },\n {\n \"transactionId\": \"\",\n \"status\": \"EXPIRED\",\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"DIGITAL_CERTIFICATE\",\n \"customSteps\": [\n \"SERPRO_IDENTITY_CHECK\",\n \"OTP_VERIFY\"\n ]\n },\n \"userExternalId\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"documentHash\": \"\",\n \"documentGroupId\": \"\"\n }\n ],\n \"count\": \"\",\n \"nextToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "225a4350-3f89-4eab-861b-9675dd869e00", "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": "CANCELLED" }, { "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "410f49d6-9cb4-4768-9a03-f31f3047aedd", "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": "CANCELLED" }, { "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53f0eadc-6a91-4351-a7d6-68d4b29c0191", "name": "Permissões insuficientes para a operação solicitada.", "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": "CANCELLED" }, { "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7278c30-c62e-484e-a1c9-9704559f1082", "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": "CANCELLED" }, { "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "692a3992-a072-4610-b592-92f94eff3f5d", "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": "827ad8d7-e789-4bf3-b3df-33a60dfd9a39", "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\": \"FAILED\",\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"policy\": {\n \"profile\": \"DIGITAL_CERTIFICATE\",\n \"customSteps\": [\n \"DIGITAL_SIGN_A1\",\n \"BIOMETRIC_LIVENESS\"\n ]\n },\n \"userExternalId\": \"\",\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"steps\": [\n {\n \"stepId\": \"\",\n \"type\": \"OTP_CHALLENGE\",\n \"status\": \"FAILED\",\n \"order\": \"\",\n \"attempts\": \"\",\n \"startedAt\": \"\",\n \"completedAt\": \"\"\n },\n {\n \"stepId\": \"\",\n \"type\": \"OTP_CHALLENGE\",\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 \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"expiresAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "465f717b-ff9e-495c-aa0e-53720cbf7463", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb7c00fa-0712-4f49-b8d1-f2151278265f", "name": "Permissões insuficientes para a operação solicitada.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62f3e92b-25e4-4d91-ac92-7fb65211e3d5", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e8be862-cc2f-420a-9d38-b5ea8a223520", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bc5104b2-9d1c-4299-8dfc-2c9b5da34bdf", "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": "63124d6a-a8ec-4d5f-aec0-336d9cca01dc", "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": "9daa81c3-2491-4a91-b823-ef0de68f7fe5", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2dd53b6-9985-4c4d-8c36-9d597bdc4fa7", "name": "Permissões insuficientes para a operação solicitada.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "031f7868-3869-44cc-b686-6e246761180a", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee44f39a-526d-4555-a21d-f35ce3ac8f7d", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "296c6ea4-6750-4a69-8ed0-29707a5b18b1", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "3. Documentos", "description": "Upload, pré-assinatura e download de documentos da transação.", "item": [ { "id": "28291b0a-9dbc-4005-8de2-75e5887a2489", "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": "7874d9d9-9710-4d9b-a42b-5cfde571812d", "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": "39581b97-0b23-4abd-a63b-e440ed79d416", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "35a4c4cf-2fe9-4ca0-9b40-2e7d7c35261d", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0feadb03-ddd6-4180-b464-282d2335f724", "name": "Permissões insuficientes para a operação solicitada.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3160f957-a8fd-43b5-9fb1-35481a625ec6", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8bbb44eb-8770-4e84-995d-4f8a5212e0e8", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6bfa8c5-dab2-4b99-80b7-9ae76dff8f73", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4175f457-acec-429f-b755-3a6aa34dbf41", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "925ce328-e462-4770-8766-a8184d01f149", "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": "97098672-2257-424e-8dcc-612cd6e32f98", "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": "b2b209bf-78b8-44a3-bc7d-82b8a6f5ca42", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b8262a9-50f2-45d8-837b-9f37c919c0f0", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56cf1eca-ed71-45c9-9f4d-836a36467d77", "name": "Permissões insuficientes para a operação solicitada.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1faa09a5-f056-4142-806a-4dae58eaf93a", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d453f08-7a4b-4b5a-8642-77a89ac266d3", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ab717be-dbab-4f9d-a34e-d515b5495b9e", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "dffb1982-3735-40a3-ba18-92b72f48bb27", "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": "1d680181-f891-49fa-8ed4-ed8e48530e44", "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\": \"pdf\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c21b76f-8445-4c0e-9ece-78b9ccddf781", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c235b3bd-8319-48a5-ad86-494e40dc9eb0", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d735c76-2c14-4254-aeb1-b0366d153a30", "name": "Permissões insuficientes para a operação solicitada.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ee4a2b56-6be5-4983-948c-75325b864da6", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5315e324-8b37-4a56-947a-42cf0387412c", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9863d56-6b78-486e-891d-f2f9a67efa58", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57e730ad-7f4f-43b1-92f9-e3e496fd8002", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e54baa8b-83b9-4bb6-8a90-d5e362862468", "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": "fbac4046-e2bb-4458-80a1-27caa6279686", "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\": \"generic\",\n \"originalUrl\": \"\",\n \"signedUrl\": \"\",\n \"signatureUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09362342-85ad-4da6-a66c-4fc8ad4a0bfb", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b95ea0ea-0138-4737-9ae4-c87838542fcb", "name": "Permissões insuficientes para a operação solicitada.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1aa4e87-c243-4033-ac19-396e129abfa3", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63863070-6c6e-4128-9617-5e954c15cd72", "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}", "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": "d401aa95-113c-4cc5-8409-54c78498c958", "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": "544f3392-02f5-4a4f-b661-5500e58053ed", "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\": \"BIOMETRIC_MATCH\",\n \"status\": \"STARTED\",\n \"order\": \"\",\n \"attempts\": \"\",\n \"maxAttempts\": \"\",\n \"captureMode\": \"BANK_APP\",\n \"startedAt\": \"\",\n \"completedAt\": \"\",\n \"error\": \"\"\n },\n {\n \"stepId\": \"\",\n \"type\": \"OTP_CHALLENGE\",\n \"status\": \"STARTED\",\n \"order\": \"\",\n \"attempts\": \"\",\n \"maxAttempts\": \"\",\n \"captureMode\": \"BANK_APP\",\n \"startedAt\": \"\",\n \"completedAt\": \"\",\n \"error\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "51d694d1-b586-45af-b71e-7f3b4e7bf094", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1389fd5-7a69-4906-a841-0e6e750f13e5", "name": "Permissões insuficientes para a operação solicitada.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc5674aa-443b-41d5-a9a5-bdf7bf74deb7", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a239665d-d4fb-47ea-bbff-4d20b8948551", "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}", "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": "888060ce-924b-4034-b437-b3b5c86216b1", "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\": \"HOSTED_PAGE\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "a538230b-d7c7-4444-bbc9-d55520412d65", "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\": \"HOSTED_PAGE\",\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\": \"DIGITAL_SIGN_A1\",\n \"status\": \"COMPLETED\",\n \"livenessSessionId\": \"\",\n \"hostedUrl\": \"\",\n \"message\": \"\",\n \"otpCode\": \"\",\n \"channel\": \"email\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1fed731-f0cf-4395-a8c1-204ae6d0ab10", "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\": \"HOSTED_PAGE\",\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ba27569-eb0a-41e7-aa1b-dae71be1f395", "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\": \"HOSTED_PAGE\",\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af293e05-92be-4117-be05-abae3f216451", "name": "Permissões insuficientes para a operação solicitada.", "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\": \"HOSTED_PAGE\",\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80f82d81-6a94-4f3f-908f-12763e694913", "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\": \"HOSTED_PAGE\",\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8255274a-1408-417d-8a1a-1873ba027e74", "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\": \"HOSTED_PAGE\",\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c11e735-5aea-4cad-9f07-77f7c7cce9b1", "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\": \"HOSTED_PAGE\",\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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6b10af5-d319-468d-8ea6-305842538676", "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": "c6150032-aae7-4d53-a6e6-b7e0956ad0d9", "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 \"code\": \"\",\n \"accepted\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"RG\",\n \"cpf\": \"83365538146\",\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\": \"OTP_CHALLENGE\",\n \"status\": \"COMPLETED\",\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 },\n \"documentPhotoMatch\": {\n \"similarity\": \"\",\n \"documentType\": \"RG\",\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\": \"TRANSACTION_PROVIDED\",\n \"enrolledAt\": \"\",\n \"enrollmentHash\": \"\",\n \"version\": \"\",\n \"imageHash\": \"\"\n },\n \"providerTimestamp\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cd6748c-ca4c-4433-b903-bf28fe9fa4c5", "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 \"code\": \"\",\n \"accepted\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"RG\",\n \"cpf\": \"83365538146\",\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb00ddb7-8c8b-42a4-8877-804c3919f829", "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 \"code\": \"\",\n \"accepted\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"RG\",\n \"cpf\": \"83365538146\",\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63d9a8d7-88c3-4b52-8379-6f81485a6c6b", "name": "Permissões insuficientes para a operação solicitada.", "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 \"code\": \"\",\n \"accepted\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"RG\",\n \"cpf\": \"83365538146\",\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6da916be-8ffa-4de0-9135-b16ffbde2a2f", "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 \"code\": \"\",\n \"accepted\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"RG\",\n \"cpf\": \"83365538146\",\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d2cd4b84-b098-4185-9c2e-2e31150e4965", "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 \"code\": \"\",\n \"accepted\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"RG\",\n \"cpf\": \"83365538146\",\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbecf611-a5c8-4e92-862a-ee19a6d8a1dc", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.", "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 \"code\": \"\",\n \"accepted\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"RG\",\n \"cpf\": \"83365538146\",\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec1eeb7f-51d3-4473-b1a7-dd34b2ca70d4", "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 \"code\": \"\",\n \"accepted\": \"\",\n \"documentImage\": \"\",\n \"documentType\": \"RG\",\n \"cpf\": \"83365538146\",\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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "5. Assinatura Digital", "description": "Prepare e conclua a assinatura digital ICP-Brasil A1.", "item": [ { "id": "431208f3-8982-47fb-9568-f58337ed1902", "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": "94367568-47b0-4e15-aa0f-18921eebe2d4", "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": "61db74bc-38a9-44a9-b9d6-122f13633213", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b0f2008-a1b0-41a7-85f2-68faa864f5dc", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "82f6675f-a930-4423-bf3f-e5d7a38cd45f", "name": "Permissões insuficientes para a operação solicitada.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8a20c8c-1293-48f3-a4af-7df22e3c0a7e", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0fcd4065-6b2c-4674-ac4a-a2eaf6193f79", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1086b9b2-bb38-4ac0-bf7d-4282d767b1a8", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdbc6bdd-7b05-411a-9c11-23341d016e1b", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "82c21168-db10-4762-89f5-11ab2a1b890c", "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": "971b3bb4-979f-4849-bcbe-0d2aa05f58a1", "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 }\n },\n \"stepId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16c1a7f5-3116-45a4-b089-7ad076dc6f48", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef9004b4-2f81-4f38-ac98-c60b967fca70", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "853ad872-b296-42b5-a2db-f5a7b456dfa4", "name": "Permissões insuficientes para a operação solicitada.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "439c7296-b857-41da-8b1b-26f689e0dd72", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "233aebe7-4cc2-4393-bcef-042d2053f197", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cede85b2-765b-424a-b960-db7743dca715", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8a959a9-9f4d-45e8-a8ea-274d415cee3e", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "6. Finalizar", "description": "Finalize a transação e consulte a evidência gerada.", "item": [ { "id": "abef8861-1060-43ab-a311-64f4c61c446b", "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": "e0857cea-1c41-452e-9851-555ee013c929", "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": "f09f35d0-dec0-43d2-a0a6-61df8d17f06e", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e1cdeb4-d60e-4d22-9916-14e027bf3101", "name": "Permissões insuficientes para a operação solicitada.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "108dba79-f23b-4a20-8454-8a3c6ad9088c", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ab7538b-e4c6-4502-89d8-29a490d2ede1", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "36f904f8-07d2-4d30-8d35-c152ae675a5f", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c0ba2e1-72f5-4b66-87b3-7b8f5f3e769b", "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}", "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": "996bdf02-3946-4a46-9241-36bf27380d9e", "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": "0f35f88f-184b-4012-b613-62a2bcf03382", "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": "b6a4f522-395b-425b-befb-b1cecf64ce03", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eab27482-135a-48c3-a36f-935560316320", "name": "Permissões insuficientes para a operação solicitada.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50c716e2-7c90-465c-a0d4-c6b68a453177", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e17d5eed-d8b8-468e-a163-5fdca92459b9", "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}", "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": "c482f22c-ab59-4754-998f-8126fb553893", "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", "type": "text/plain" }, "url": { "path": [ "v1", "verify", "document" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "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": "b3b3f97d-b8ed-4da5-88d7-c2198620e182", "name": "Documento inspecionado com sucesso.", "originalRequest": { "url": { "path": [ "v1", "verify", "document" ], "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 \"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\": \"digital_certificate\",\n \"confidence\": \"\",\n \"subFilter\": \"\",\n \"filter\": \"\"\n },\n {\n \"method\": \"\",\n \"type\": \"digital_certificate\",\n \"confidence\": \"\",\n \"subFilter\": \"\",\n \"filter\": \"\"\n }\n ],\n \"checkedAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb13b1e0-50d1-4b53-9369-5aa5418a4277", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "verify", "document" ], "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 \"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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3b001f5-f5ba-48dd-be99-f7ce52ee2fd6", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "verify", "document" ], "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 \"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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e01a2e4c-fc72-4169-9909-c70d32abcb4c", "name": "Permissões insuficientes para a operação solicitada.", "originalRequest": { "url": { "path": [ "v1", "verify", "document" ], "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 \"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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05517bf0-97b8-4afc-ad9e-c5ef931bc1e6", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.", "originalRequest": { "url": { "path": [ "v1", "verify", "document" ], "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 \"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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70c7b78e-043a-48a7-92ec-e2782a71bf25", "name": "Limite de requisições excedido.", "originalRequest": { "url": { "path": [ "v1", "verify", "document" ], "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 \"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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "84918bc2-7c6a-4ed6-9735-f61388c1edd6", "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", "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": "68692a9a-84b8-4569-8bfc-ba60cecf5016", "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\": \"ACTIVE\",\n \"signingMode\": \"PARALLEL\",\n \"totalSigners\": \"\",\n \"completedSessions\": \"\",\n \"documentHash\": \"\",\n \"signers\": [\n {\n \"signerIndex\": \"\",\n \"displayName\": \"\",\n \"status\": \"EXPIRED\",\n \"cpfCnpj\": \"\",\n \"policyProfile\": \"\",\n \"evidenceId\": \"\",\n \"completedAt\": \"\"\n },\n {\n \"signerIndex\": \"\",\n \"displayName\": \"\",\n \"status\": \"IN_PROGRESS\",\n \"cpfCnpj\": \"\",\n \"policyProfile\": \"\",\n \"evidenceId\": \"\",\n \"completedAt\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"tenantName\": \"\",\n \"tenantCnpj\": \"\",\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": "906d4dd0-6614-4675-937e-75b10ae1ae0d", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc7826f4-d96a-4062-9382-8793ee94f2ce", "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": "57621e6f-ad26-4241-843c-08c68db6cdfe", "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\": \"CUSTOM\",\n \"customSteps\": [\n \"CLICK_ACCEPT\",\n \"DIGITAL_SIGN_A1\"\n ]\n },\n \"steps\": [\n {\n \"type\": \"DIGITAL_SIGN_A1\",\n \"status\": \"STARTED\",\n \"order\": \"\",\n \"completedAt\": \"\"\n },\n {\n \"type\": \"DOCUMENT_PHOTO_MATCH\",\n \"status\": \"PENDING\",\n \"order\": \"\",\n \"completedAt\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"completedAt\": \"\",\n \"documentHash\": \"\",\n \"signer\": {\n \"displayName\": \"\",\n \"cpfCnpj\": \"\"\n },\n \"tenantName\": \"\",\n \"tenantCnpj\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fff7a5ba-097d-4a46-91d5-7a96d4d2ab0c", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2303dd62-cbc1-4a84-b055-f2a58a7b093d", "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": "e317cb61-9aa6-4093-bbc7-5911f99bed39", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63600592-3141-43e9-a875-a985bed2b98e", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "8. Webhooks", "description": "Registre, liste, teste e remova webhooks de notificação.", "item": [ { "id": "42aba4ff-a56c-4bad-bcab-08e412996a47", "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\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 \"STEP.COMPLETED\",\n \"STEP.FAILED\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "7861d465-b844-4d95-a897-aefd08351128", "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 \"TRANSACTION.COMPLETED\"\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 \"TRANSACTION.FAILED\",\n \"SIGNING_SESSION.CANCELLED\"\n ],\n \"status\": \"ACTIVE\",\n \"createdAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b1a21d4-4da1-4317-afe5-630844e11799", "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 \"TRANSACTION.COMPLETED\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ddb23f5-a26c-4bb7-a604-df9bd2a8c3f7", "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 \"TRANSACTION.COMPLETED\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05f375bf-d325-465f-9aba-d174e3c93188", "name": "Permissões insuficientes para a operação solicitada.", "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 \"TRANSACTION.COMPLETED\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b3a96315-634e-4212-99a0-c80c90057794", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.", "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 \"TRANSACTION.COMPLETED\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "916d3e6c-c001-4937-b11b-a9678086cd8b", "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 \"TRANSACTION.COMPLETED\"\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}", "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": "c7702425-62bc-4b4f-a210-6a8e07e0f6e9", "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": "b80bf877-8829-4ca6-bce9-c2e3098142c5", "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 \"SIGNING_SESSION.EXPIRED\",\n \"STEP.FAILED\"\n ],\n \"status\": \"DISABLED\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"webhookId\": \"\",\n \"url\": \"\",\n \"events\": [\n \"STEP.COMPLETED\",\n \"SIGNING_SESSION.EXPIRED\"\n ],\n \"status\": \"DISABLED\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f15edaa-0532-43f2-8f55-e3c361c2f754", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f48c3c2-d22b-499c-a552-00dcab38e709", "name": "Permissões insuficientes para a operação solicitada.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11035bd7-ec50-4c92-86ff-fabeab7d9e12", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "74a8914b-c010-4b2c-a7e2-ac2ef5d5f09d", "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": "fdd3e420-9e04-4250-8a93-b470871c3896", "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": "58bc4d91-743b-4a01-b28d-400e01657144", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19d07917-3969-4835-8786-27afff3b7c3a", "name": "Permissões insuficientes para a operação solicitada.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfbad671-a666-4b0b-97d5-be1d6066ff8d", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbd6098f-63d6-4d0c-85ea-48cfeb29519f", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e6f29bfa-febb-4b52-b796-279d527cf7f1", "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": "54de4f22-8270-4cd6-9a2f-fcbd8420aaf6", "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": "87fd358f-c732-4241-86fa-f39358dbea03", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2ed24be-8ed8-4f77-8e83-f9730f15ad2d", "name": "Permissões insuficientes para a operação solicitada.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e545430-8969-446b-945a-4ac1ba85113d", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c65eeff7-8f7a-4bb8-b155-b454a5c9c981", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "9. Usuários", "description": "Cadastro e enrollment biométrico de usuários.", "item": [ { "id": "b0016a71-9b8f-42f1-8b1b-dcf21b401bac", "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": "f67054b9-a75f-423a-9a1b-bcaa8a83b57c", "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\": \"47541415226\",\n \"source\": \"BANK_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\": \"FIRST_LIVENESS\",\n \"enrolledAt\": \"\",\n \"cpf\": \"\",\n \"faceConfidence\": \"\",\n \"documentImageHash\": \"\",\n \"extractionConfidence\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5902853a-d7d4-44dd-9fb2-2adef95ebf08", "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\": \"47541415226\",\n \"source\": \"BANK_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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ea62cc9-1d1d-4eeb-8fb5-dac1f4549497", "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\": \"47541415226\",\n \"source\": \"BANK_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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b04a2100-3d5c-42f4-877d-7ed52c9c394a", "name": "Permissões insuficientes para a operação solicitada.", "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\": \"47541415226\",\n \"source\": \"BANK_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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3fa8f2e2-ef89-49db-b16b-29e734778f3e", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.", "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\": \"47541415226\",\n \"source\": \"BANK_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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18b89479-3339-41f8-94a4-7a04d2de51ff", "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\": \"47541415226\",\n \"source\": \"BANK_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}", "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": "55da9d7e-b70c-4168-a773-f86e9e7c83f1", "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\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.", "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\": \"BIOMETRIC_PLUS_OTP\",\n \"customSteps\": [\n \"OTP_CHALLENGE\",\n \"OTP_CHALLENGE\"\n ]\n },\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\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\": \"#87c3E6\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#9Aa4cB\",\n \"textColor\": \"#412631\",\n \"buttonTextColor\": \"#dE2F5b\",\n \"borderRadius\": \"334204383px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "31a5f5d4-060d-44ae-849b-7e86d160a2ab", "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.", "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\": \"BIOMETRIC_PLUS_OTP\",\n \"customSteps\": [\n \"OTP_CHALLENGE\",\n \"OTP_CHALLENGE\"\n ]\n },\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\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\": \"#87c3E6\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#9Aa4cB\",\n \"textColor\": \"#412631\",\n \"buttonTextColor\": \"#dE2F5b\",\n \"borderRadius\": \"334204383px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\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\": \"CANCELLED\",\n \"url\": \"\",\n \"clientSecret\": \"\",\n \"expiresAt\": \"\",\n \"createdAt\": \"\",\n \"inviteSent\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "58832bd7-ba1e-44a6-8e3e-056be9afed09", "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.", "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\": \"BIOMETRIC_PLUS_OTP\",\n \"customSteps\": [\n \"OTP_CHALLENGE\",\n \"OTP_CHALLENGE\"\n ]\n },\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\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\": \"#87c3E6\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#9Aa4cB\",\n \"textColor\": \"#412631\",\n \"buttonTextColor\": \"#dE2F5b\",\n \"borderRadius\": \"334204383px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae9d943d-2bbf-4955-b136-2b2ce57b178d", "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.", "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\": \"BIOMETRIC_PLUS_OTP\",\n \"customSteps\": [\n \"OTP_CHALLENGE\",\n \"OTP_CHALLENGE\"\n ]\n },\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\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\": \"#87c3E6\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#9Aa4cB\",\n \"textColor\": \"#412631\",\n \"buttonTextColor\": \"#dE2F5b\",\n \"borderRadius\": \"334204383px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f04eecfc-9704-4764-8c45-eace83626115", "name": "Permissões insuficientes para a operação solicitada.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada.", "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\": \"BIOMETRIC_PLUS_OTP\",\n \"customSteps\": [\n \"OTP_CHALLENGE\",\n \"OTP_CHALLENGE\"\n ]\n },\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\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\": \"#87c3E6\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#9Aa4cB\",\n \"textColor\": \"#412631\",\n \"buttonTextColor\": \"#dE2F5b\",\n \"borderRadius\": \"334204383px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c887525-dc02-4db6-912c-f10847baf8e7", "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.", "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\": \"BIOMETRIC_PLUS_OTP\",\n \"customSteps\": [\n \"OTP_CHALLENGE\",\n \"OTP_CHALLENGE\"\n ]\n },\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\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\": \"#87c3E6\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#9Aa4cB\",\n \"textColor\": \"#412631\",\n \"buttonTextColor\": \"#dE2F5b\",\n \"borderRadius\": \"334204383px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f33ddac7-a12d-4e2a-95a6-713427c15026", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada.", "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\": \"BIOMETRIC_PLUS_OTP\",\n \"customSteps\": [\n \"OTP_CHALLENGE\",\n \"OTP_CHALLENGE\"\n ]\n },\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\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\": \"#87c3E6\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#9Aa4cB\",\n \"textColor\": \"#412631\",\n \"buttonTextColor\": \"#dE2F5b\",\n \"borderRadius\": \"334204383px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4629ada-d4b6-47ca-81a1-0f7f585ccb19", "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.", "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\": \"BIOMETRIC_PLUS_OTP\",\n \"customSteps\": [\n \"OTP_CHALLENGE\",\n \"OTP_CHALLENGE\"\n ]\n },\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\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\": \"#87c3E6\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#9Aa4cB\",\n \"textColor\": \"#412631\",\n \"buttonTextColor\": \"#dE2F5b\",\n \"borderRadius\": \"334204383px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "168b55cc-0815-4f5a-a3ea-2330870a9e4e", "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.", "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\": \"BIOMETRIC_PLUS_OTP\",\n \"customSteps\": [\n \"OTP_CHALLENGE\",\n \"OTP_CHALLENGE\"\n ]\n },\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\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\": \"#87c3E6\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#9Aa4cB\",\n \"textColor\": \"#412631\",\n \"buttonTextColor\": \"#dE2F5b\",\n \"borderRadius\": \"334204383px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "60f7e210-dfc4-4587-83f4-7609e8af5c0f", "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": "CANCELLED" }, { "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": "bc4e295b-1ef0-4030-ba26-2e51b92170e7", "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": "CANCELLED" }, { "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\": \"COMPLETED\",\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": "8f397871-9c7b-454f-a3bf-0d0adf8751df", "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": "CANCELLED" }, { "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "448f5ef6-4e01-42e3-86a0-149d2ec6bff7", "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": "CANCELLED" }, { "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99f96e26-ee31-4904-b915-c1bd27a1f272", "name": "Permissões insuficientes para a operação solicitada.", "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": "CANCELLED" }, { "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "968a0fd3-245f-48e5-804d-cdbea8fe13d9", "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": "CANCELLED" }, { "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a66e3517-346e-45f0-8782-64efdd90a9a1", "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": "cf72bfc4-070d-4bab-92bc-b1d4a9af17b6", "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\": \"EXPIRED\",\n \"purpose\": \"ACTION_AUTHENTICATION\",\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\": \"#4Ae6F5\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#ebdac5\",\n \"textColor\": \"#964DE8\",\n \"buttonTextColor\": \"#ADEE54\",\n \"borderRadius\": \"425468px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "760f4c75-6219-42a7-9d7b-d2c65c5b960e", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cae58883-eaf2-44e6-a622-f2f6c5f37c49", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5c1f248-45ef-4381-a83c-58abe03f2299", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b40db9e-1c66-4aa6-8cac-ab7edfd054d2", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e313d0d6-295f-40c0-ad21-1e819c41715f", "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 \"otpCode\": \"\",\n \"otpChannel\": \"email\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"WIFI\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "7c082971-3cb0-4263-94db-62f5bef45ef0", "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 \"otpCode\": \"\",\n \"otpChannel\": \"email\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"WIFI\"\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\": \"EXPIRED\",\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 }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11796dd8-5eea-4b73-96d3-82701cf0f02d", "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 \"otpCode\": \"\",\n \"otpChannel\": \"email\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"WIFI\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3f908994-2fbc-4db0-878e-77207c889a6e", "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 \"otpCode\": \"\",\n \"otpChannel\": \"email\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"WIFI\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eea71a07-4d2c-4ccb-be56-6e8a0618d3c5", "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 \"otpCode\": \"\",\n \"otpChannel\": \"email\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"WIFI\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91568560-289a-405c-8957-f095ff2c5c7b", "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 \"otpCode\": \"\",\n \"otpChannel\": \"email\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"WIFI\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "86c96f56-aceb-4020-ad9e-6d54752fcc92", "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 \"otpCode\": \"\",\n \"otpChannel\": \"email\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"WIFI\"\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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d00f5a8f-9b87-4dc2-8544-bdd5051e492a", "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": "40478555-f1c3-4e07-9f87-bd9b2afa2173", "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\": \"EXPIRED\",\n \"completedAt\": \"\",\n \"evidenceId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "05a47046-f117-43d6-ae73-45120e10df26", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01a5fcfa-19c2-4005-8558-8b56cb64d9f1", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95b1de56-1f50-4800-a603-30381df4caf7", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d78f467a-ef17-466c-afe6-8359a1aa29f8", "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": "0cec5764-fcbf-4a5c-b5c1-0cc98bdf155f", "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\": \"CANCELLED\",\n \"cancelledAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e018001-d6b4-4e9a-961e-000055dc14ae", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8f75056-c5db-404c-9bc2-b0d581b4c673", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bf50c7fe-b21e-43c7-9809-7208fdfba4f4", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bf469a9-b45e-4edb-9dda-5e3bf4e6e28e", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f2de9d4-6824-4243-b514-365992eb3bce", "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(email/SMS). O canal só é aceito quando a sessão foi criada com\n`signer.otpChannelSelectable`; caso contrário a requisição retorna 400.\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": "2308c7a2-c3e6-48c8-b0fe-d681eb32b4b8", "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\": \"EXPIRED\",\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 }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e3026666-1b1a-4630-a573-6679d906c186", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebebfb06-2c5f-4bc9-b1cf-144be5851ce1", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e653d02-dbe7-4ecb-878d-915dc04d7c5f", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c61493d7-67c6-4551-89df-c7fc098f73e6", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7be90678-b017-4dfa-bf5e-1724131df2ff", "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}", "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": "9d299fca-f2eb-4672-aa00-2fe2b7ba6538", "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\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.", "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 },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 1440,\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "7c224579-fb7c-47aa-9e17-10e436ec525c", "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.", "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 },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 1440,\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\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 \"envelopeId\": \"\",\n \"status\": \"COMPLETED\",\n \"signingMode\": \"SEQUENTIAL\",\n \"totalSigners\": \"\",\n \"documentHash\": \"\",\n \"createdAt\": \"\",\n \"expiresAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b8128a35-edd5-4b53-ab73-1afe5c686328", "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.", "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 },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 1440,\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41614a14-eedd-411c-97a5-af25e64810a5", "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.", "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 },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 1440,\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e1903a8-84a3-4a45-b562-6a95b05f9de3", "name": "Permissões insuficientes para a operação solicitada.", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada.", "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 },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 1440,\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcb8e7ef-f443-492b-8739-5d63a179549b", "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.", "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 },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 1440,\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d5d7b85-fa1f-4dc9-8a9e-512b3749db22", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Chave de idempotência para evitar criação duplicada.", "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 },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 1440,\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03fbb1a4-478d-4c16-a769-2f26e75d7870", "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.", "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 },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 1440,\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98a9adb8-cb05-4057-b438-f467254c7bd5", "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.", "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 },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 1440,\n \"owner\": {\n \"email\": \"\",\n \"name\": \"\"\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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4fb23947-0cb0-483e-8a3a-e62567998671", "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": "bb49daca-ac5a-4b23-b899-a7ed635790ea", "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\": \"CANCELLED\",\n \"signingMode\": \"SEQUENTIAL\",\n \"totalSigners\": \"\",\n \"addedSessions\": \"\",\n \"completedSessions\": \"\",\n \"documentHash\": \"\",\n \"sessions\": [\n {\n \"sessionId\": \"\",\n \"transactionId\": \"\",\n \"signerIndex\": \"\",\n \"signerName\": \"\",\n \"status\": \"FAILED\",\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": "94dd4873-5058-418c-8f74-866c77bf5671", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb94d820-dda1-40b8-ab51-a26facf3df95", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "673d98fe-749b-4151-97cf-258aa7008977", "name": "Permissões insuficientes para a operação solicitada.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ff976da-3b6f-40d6-80d2-80c0155ce4d8", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9e860c2-a254-495d-83ad-6ec67dff9583", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b31a602e-a2fe-4740-a6bb-97633aa29651", "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.\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": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"signer\": {\n \"cpf\": 6218\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}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "a8af54bf-cdda-43a1-8061-0eee7c8e927c", "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": [ { "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\": 6218\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}", "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\": \"CANCELLED\",\n \"url\": \"\",\n \"clientSecret\": \"\",\n \"expiresAt\": \"\",\n \"inviteSent\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fffae28c-859e-4e88-a15c-1b1c17190582", "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": [ { "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\": 6218\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}", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bec715b2-9267-444f-9cbb-d22737b05221", "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": [ { "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\": 6218\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}", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "270c1c91-5c3a-4737-b89f-d722077ba64a", "name": "Permissões insuficientes para a operação solicitada.", "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": [ { "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\": 6218\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}", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9212e866-de13-4539-8936-2f5588f9da61", "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": [ { "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\": 6218\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}", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "371a3970-4f5e-493f-ba3b-ff3d10c445ef", "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": [ { "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\": 6218\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}", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d5a7796-f690-487b-9c62-1d3e07b5c2ea", "name": "Entidade não processável — a requisição é sintaticamente válida mas semanticamente incorreta.", "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": [ { "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\": 6218\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}", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84e142a5-a037-4422-ad36-089f823f4dd6", "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": [ { "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\": 6218\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}", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c39b7e92-8763-4426-8616-e6891a9211c4", "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": [ { "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\": 6218\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}", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "c41191de-9efc-448f-bb27-461d8764f2c1", "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\nRequer scope `transactions:read`.\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": "1abb0137-ea01-4965-8423-2fe955fedc60", "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": "a83c50fb-1ff6-44d0-84a5-c8794a26e863", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7749099-f95f-4897-94fc-e639881757f5", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af7137fe-24a1-43ac-bffe-a6a3aa58d74b", "name": "Permissões insuficientes para a operação solicitada.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9b1d20e-25b6-4dd9-9e8a-3717704fc01e", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb7d6e1a-ede5-402b-921c-6c4c48c65b0c", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54149c2f-1a98-42a8-a908-5cacd71e0013", "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}", "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": "9d1647bf-9e9f-45db-bdfd-a51d757ae9a6", "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": "6feb0af3-f37e-41dc-98f5-994990f7120c", "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": "c30323d8-c104-4afd-8df9-a973c90c2896", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab9331ea-88f8-4cc9-a785-fa1e2d4a4ef9", "name": "Permissões insuficientes para a operação solicitada.", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f815f1e-cb9b-41d0-8fcc-9fb4b6502ad9", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16d9f8f0-2b91-44e6-beaa-6ba10fcfb576", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "238c2659-bf04-4bdb-badd-51689143c522", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Health", "description": "Verificação de saúde da API.", "item": [ { "id": "e9524736-d8f7-498f-8f22-717294720d84", "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": "f794c26a-b1a1-421f-aaec-d4f197f81165", "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\": \"down\",\n \"latencyMs\": \"\"\n },\n \"s3\": {\n \"status\": \"down\",\n \"latencyMs\": \"\"\n },\n \"kms\": {\n \"status\": \"operational\",\n \"latencyMs\": \"\"\n },\n \"mtlsTruststore\": {\n \"status\": \"down\",\n \"latencyMs\": \"\"\n }\n },\n \"latencyMs\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb387398-7256-4f71-aa1f-16da7fa32047", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "721a52c1-2a82-403f-823e-8bede377af32", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47c521cd-17ad-4835-a88b-658d1f6881c1", "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}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a704403b-ceea-4aca-a66f-2f8512c3fdbb", "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": "4e2323f7-9fe9-457d-8931-89d14f7cbf28", "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\": \"7d\",\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\": \"down\",\n \"latencyMs\": \"\"\n },\n \"kms\": {\n \"status\": \"down\",\n \"latencyMs\": \"\"\n },\n \"mtlsTruststore\": {\n \"status\": \"operational\",\n \"latencyMs\": \"\"\n }\n },\n \"checkedAt\": \"\",\n \"totalLatencyMs\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d863689-e50e-44d8-9ace-e79a19c9cf4d", "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}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "521e5fce-7d85-4381-965d-c4a24167b1d7", "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}", "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": "4f1ecfa0-4987-4ec1-96f4-3e63b7ad6d10", "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" } } }