{ "item": [ { "name": "1. Autenticação", "description": "Obtenha o token de acesso via OAuth2 client_credentials.", "item": [ { "id": "c3647ce0-aa27-4ca9-a176-13ad7363b2a1", "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": "2f4b0532-a371-439f-9e4f-f9f9ca5ecb2a", "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": "9163bb65-763e-4a3e-bf3b-d9d3fc874712", "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": "a39965f3-fc69-4ec0-892c-70c32b9ed467", "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": "68fcce44-9760-414e-9b4e-74f49a1843da", "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": "8b224b1c-2f68-4e10-a96a-573ffa1a29f9", "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\": \"DOCUMENT_SIGNATURE\",\n \"policy\": {\n \"profile\": \"CUSTOM\",\n \"customSteps\": [\n \"DIGITAL_SIGN_A1\",\n \"BIOMETRIC_MATCH\"\n ]\n },\n \"signer\": {\n \"cpf\": 3617.0977143087725\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\": \"DOCUMENT_UPLOADED\",\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"CUSTOM\",\n \"customSteps\": [\n \"BIOMETRIC_LIVENESS\",\n \"OTP_CHALLENGE\"\n ]\n },\n \"steps\": [\n {\n \"stepId\": \"\",\n \"type\": \"BIOMETRIC_MATCH\",\n \"status\": \"STARTED\",\n \"order\": \"\"\n },\n {\n \"stepId\": \"\",\n \"type\": \"SERPRO_IDENTITY_CHECK\",\n \"status\": \"STARTED\",\n \"order\": \"\"\n }\n ],\n \"userExternalId\": \"\",\n \"createdAt\": \"\",\n \"documentHash\": \"\",\n \"expiresAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd448f05-f1d4-41bc-ac70-3a2a028333f6", "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\": \"DOCUMENT_SIGNATURE\",\n \"policy\": {\n \"profile\": \"CUSTOM\",\n \"customSteps\": [\n \"DIGITAL_SIGN_A1\",\n \"BIOMETRIC_MATCH\"\n ]\n },\n \"signer\": {\n \"cpf\": 3617.0977143087725\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": "4ebe5950-2938-448a-8a77-6050e623685e", "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\": \"DOCUMENT_SIGNATURE\",\n \"policy\": {\n \"profile\": \"CUSTOM\",\n \"customSteps\": [\n \"DIGITAL_SIGN_A1\",\n \"BIOMETRIC_MATCH\"\n ]\n },\n \"signer\": {\n \"cpf\": 3617.0977143087725\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": "437553b9-ffc6-40f9-873c-5b9d264aaefd", "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\": \"DOCUMENT_SIGNATURE\",\n \"policy\": {\n \"profile\": \"CUSTOM\",\n \"customSteps\": [\n \"DIGITAL_SIGN_A1\",\n \"BIOMETRIC_MATCH\"\n ]\n },\n \"signer\": {\n \"cpf\": 3617.0977143087725\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": "8af41679-bf45-44b9-9894-10c7f0fbe189", "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\": \"DOCUMENT_SIGNATURE\",\n \"policy\": {\n \"profile\": \"CUSTOM\",\n \"customSteps\": [\n \"DIGITAL_SIGN_A1\",\n \"BIOMETRIC_MATCH\"\n ]\n },\n \"signer\": {\n \"cpf\": 3617.0977143087725\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": "fa1d965c-1df5-413a-93a7-7fbfd388ee8f", "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\": \"DOCUMENT_SIGNATURE\",\n \"policy\": {\n \"profile\": \"CUSTOM\",\n \"customSteps\": [\n \"DIGITAL_SIGN_A1\",\n \"BIOMETRIC_MATCH\"\n ]\n },\n \"signer\": {\n \"cpf\": 3617.0977143087725\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": "c145cdee-a9ff-4223-b073-fc1476233b93", "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\": \"DOCUMENT_SIGNATURE\",\n \"policy\": {\n \"profile\": \"CUSTOM\",\n \"customSteps\": [\n \"DIGITAL_SIGN_A1\",\n \"BIOMETRIC_MATCH\"\n ]\n },\n \"signer\": {\n \"cpf\": 3617.0977143087725\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": "75c5a58b-55b7-4dc7-8a76-5d29c9981e90", "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\": \"DOCUMENT_SIGNATURE\",\n \"policy\": {\n \"profile\": \"CUSTOM\",\n \"customSteps\": [\n \"DIGITAL_SIGN_A1\",\n \"BIOMETRIC_MATCH\"\n ]\n },\n \"signer\": {\n \"cpf\": 3617.0977143087725\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": "8131cb6b-25d1-430c-8cce-7c9f58265da3", "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": "IN_PROGRESS" }, { "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": "978b4ca4-2f41-4e71-99f8-de7cb8495c62", "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": "IN_PROGRESS" }, { "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\": \"DOCUMENT_UPLOADED\",\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"policy\": {\n \"profile\": \"BIOMETRIC_PLUS_OTP\",\n \"customSteps\": [\n \"BIOMETRIC_LIVENESS\",\n \"DOCUMENT_PHOTO_MATCH\"\n ]\n },\n \"userExternalId\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"documentHash\": \"\",\n \"documentGroupId\": \"\"\n },\n {\n \"transactionId\": \"\",\n \"status\": \"FAILED\",\n \"purpose\": \"ACTION_AUTHENTICATION\",\n \"policy\": {\n \"profile\": \"CLICK_PLUS_OTP\",\n \"customSteps\": [\n \"DOCUMENT_PHOTO_MATCH\",\n \"BIOMETRIC_LIVENESS\"\n ]\n },\n \"userExternalId\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"documentHash\": \"\",\n \"documentGroupId\": \"\"\n }\n ],\n \"count\": \"\",\n \"nextToken\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7ae2376-7906-4524-a378-31c6a579c328", "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": "IN_PROGRESS" }, { "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": "9ddf13db-16d0-46a7-baf5-7b74a6ebd496", "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": "IN_PROGRESS" }, { "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": "2798f3e4-19b7-40cb-8645-b6f1045cd17d", "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": "IN_PROGRESS" }, { "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": "4f0e6c93-ebcd-4c9f-84c1-e9390ed5c5ff", "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": "IN_PROGRESS" }, { "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": "ea8e0bbc-56d2-4656-bf6e-1a59a3d4be3e", "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": "fc576b4b-087e-427c-8580-2e381c985c96", "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\": \"CUSTOM\",\n \"customSteps\": [\n \"BIOMETRIC_LIVENESS\",\n \"DOCUMENT_PHOTO_MATCH\"\n ]\n },\n \"userExternalId\": \"\",\n \"signer\": {\n \"cpf\": \"string\"\n },\n \"steps\": [\n {\n \"stepId\": \"\",\n \"type\": \"CLICK_ACCEPT\",\n \"status\": \"COMPLETED\",\n \"order\": \"\",\n \"attempts\": \"\",\n \"startedAt\": \"\",\n \"completedAt\": \"\"\n },\n {\n \"stepId\": \"\",\n \"type\": \"BIOMETRIC_LIVENESS\",\n \"status\": \"STARTED\",\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 \"key_3\": \"\"\n },\n \"expiresAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2730c491-9c0d-4a4c-90d4-f572824bc5a0", "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": "2b23836a-a076-4745-ace5-95b23bd05800", "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": "1a667e6b-c6de-42bc-bc11-6b7077db55ea", "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": "70c0fbb1-df43-442b-a303-c899d203e021", "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": "ee6b977f-a7e3-4385-8625-ba2b8cea70a3", "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": "77a270e2-da0d-4984-9119-19cadad42575", "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": "16ed1070-ec96-4407-a7b4-277d5041300a", "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": "00081672-2eb4-4f3f-b87a-8c55bf33f119", "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": "a75b3063-5ce2-400a-93fc-45e0526c92e4", "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": "e62c7403-0988-431d-99dd-7e9f254d6fde", "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": "2bf49286-4738-43fc-aae1-8675c84dafa6", "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": "d8be09d2-6d49-4760-b258-e517e5291704", "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": "a78f79fe-76b2-42e7-b28f-b6cc615c241f", "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": "0a870b44-3310-485b-ad68-d709b127b6c3", "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": "abc39bcb-575a-4e66-bd41-87e03701dd17", "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": "533b5c01-9872-43cc-92f0-7bfe74c6d549", "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": "9de50ea1-6e9e-4d0c-b61f-326331313c7f", "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": "7254eae8-6a45-4ddf-95c8-292cd4fbaa99", "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": "9981c429-eac6-44dc-a47f-26316bf0bae5", "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": "af76703b-9566-4597-86dd-0cae496b1db4", "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": "bcbd2717-da72-42ff-8ba5-a5ef1c9dda9f", "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": "8a87df38-a7c1-4ceb-87e2-7ae465485842", "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": "7fcc8b40-b359-4e85-829f-6072d6d8750b", "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": "92209270-67d2-449d-98b8-14b3c17303e4", "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": "1fb9b65e-bb46-4a77-a680-dafc04efb996", "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": "436dd2ca-8472-4109-8a02-5c24cac9af55", "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": "c4f86ce7-c622-4322-a2e9-45b43b536d9b", "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": "f3c22f72-df66-45ac-9111-67bc50913af6", "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": "9fd64249-1bd0-4547-a77d-978ec0e7bf13", "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": "40a625e6-25e2-469e-95b4-a55f8d53129e", "name": "Upload confirmado com sucesso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "document", "confirm" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"uploadToken\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"transactionId\": \"\",\n \"status\": \"DOCUMENT_UPLOADED\",\n \"documentHash\": \"\",\n \"documentFormat\": \"generic\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e08dabb-6893-48a3-99e5-ef8e0b066f83", "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": "722e5c1a-8eed-406c-ac1e-768e1ec6b6c4", "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": "64ea5cb1-583a-401b-b770-dc297b4edba2", "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": "ab63204d-d5d4-4afb-bd56-abd093908398", "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": "730eb7c9-ab69-476e-b32c-4240557217b5", "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": "d2abc064-86bb-417d-b060-2c2feb8e50fb", "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": "dac6c3e1-d09f-4673-8d42-bf6543186347", "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": "aa7f59f2-bd99-4c74-9649-1c984141c2b2", "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": "4bfbb88c-142b-4be4-98ef-3a49febc5649", "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": "a3557f5e-2110-4d59-9690-9093906e426a", "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": "3a8b6819-c199-48cf-a413-da85833b1321", "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": "3d1f75c1-f6f3-4473-8572-6b4b2cd12770", "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": "d651ca53-fb2c-42be-99dc-0691b7c91103", "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": "037274fe-8f89-4178-b76e-cc0c7d455874", "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": "7b027ee0-023f-4685-8a3e-aa308bbf4219", "name": "Lista de etapas retornada com sucesso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"steps\": [\n {\n \"stepId\": \"\",\n \"type\": \"OTP_VERIFY\",\n \"status\": \"FAILED\",\n \"order\": \"\",\n \"attempts\": \"\",\n \"maxAttempts\": \"\",\n \"captureMode\": \"HOSTED_PAGE\",\n \"startedAt\": \"\",\n \"completedAt\": \"\",\n \"error\": \"\"\n },\n {\n \"stepId\": \"\",\n \"type\": \"BIOMETRIC_LIVENESS\",\n \"status\": \"COMPLETED\",\n \"order\": \"\",\n \"attempts\": \"\",\n \"maxAttempts\": \"\",\n \"captureMode\": \"BANK_APP\",\n \"startedAt\": \"\",\n \"completedAt\": \"\",\n \"error\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "032df23e-63f1-4df7-91f5-142580415dea", "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": "66a89d13-30c2-4771-87f6-c176da2d7c65", "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": "aa583b16-5b44-493e-a7c3-f1a52626b833", "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": "95cbd56b-0efc-490e-a333-28a1e52dd6f3", "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": "ed40f9f3-05df-487f-b68c-18e8159cfec8", "name": "Iniciar etapa de verificação", "request": { "name": "Iniciar etapa de verificação", "description": "Inicia uma etapa de verificação de identidade.\n\n**Reenvio de OTP**: Ao chamar `start` novamente em uma etapa `OTP_CHALLENGE` (attempt > 1), um novo código OTP é enviado e a etapa `OTP_VERIFY` pareada é automaticamente resetada se estava em status `FAILED` ou `STARTED`.", "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "start" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "transactionId", "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" } }, { "type": "any", "value": "", "key": "stepId", "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"captureMode\": \"BANK_APP\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "6ed577ca-99c7-4905-a91d-8dc489ee5de1", "name": "Etapa iniciada com sucesso. A resposta varia conforme o tipo.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "start" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"captureMode\": \"BANK_APP\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"stepId\": \"\",\n \"type\": \"OTP_VERIFY\",\n \"status\": \"COMPLETED\",\n \"livenessSessionId\": \"\",\n \"hostedUrl\": \"\",\n \"message\": \"\",\n \"otpCode\": \"\",\n \"channel\": \"email\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f2e96f4-11ef-44fd-83ca-2f48fb5624c5", "name": "Requisição inválida — parâmetros ausentes ou malformados.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "start" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"captureMode\": \"BANK_APP\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "572534bf-bdd5-4d06-abf2-0d00f5303a7c", "name": "Autenticação ausente ou inválida.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "start" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"captureMode\": \"BANK_APP\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fcf3f59e-4b65-4221-a866-d6fd2cf3e48b", "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\": \"BANK_APP\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c020e2c-410d-40f7-9c0a-7a96b6d9db5e", "name": "Recurso não encontrado.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "start" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"captureMode\": \"BANK_APP\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50071f14-2d43-4260-b95b-002460581930", "name": "Conflito de estado — a operação não pode ser realizada no estado atual do recurso.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "start" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"captureMode\": \"BANK_APP\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83ee6c5c-d602-4505-b696-0996172b08ae", "name": "Erro interno do servidor.", "originalRequest": { "url": { "path": [ "v1", "transactions", ":transactionId", "steps", ":stepId", "start" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da transação.", "type": "text/plain" }, "type": "any", "value": "", "key": "transactionId" }, { "disabled": false, "description": { "content": "(Required) Identificador único da etapa.", "type": "text/plain" }, "type": "any", "value": "", "key": "stepId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"captureMode\": \"BANK_APP\",\n \"otpChannel\": \"email\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52354eb1-e90c-4d8b-9dc9-09d4f0e7c126", "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": "f47ab436-3476-440f-834d-4d179c311372", "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\": \"PASSPORT\",\n \"cpf\": \"22066300877\",\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\": \"CLICK_ACCEPT\",\n \"status\": \"STARTED\",\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": "31f12202-7d01-49c2-8e7b-6bd7dc34ef34", "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\": \"PASSPORT\",\n \"cpf\": \"22066300877\",\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": "50dc182e-91b3-46f7-8053-845d2d920977", "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\": \"PASSPORT\",\n \"cpf\": \"22066300877\",\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": "17dbc639-62c3-4c07-9265-c994b68c3cca", "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\": \"PASSPORT\",\n \"cpf\": \"22066300877\",\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": "762ace67-8f62-4375-b262-0490197766b6", "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\": \"PASSPORT\",\n \"cpf\": \"22066300877\",\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": "dbadac07-67eb-433e-aa89-b0ddcd68b505", "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\": \"PASSPORT\",\n \"cpf\": \"22066300877\",\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": "d9a209c3-ec97-4478-8288-077ffb378c43", "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\": \"PASSPORT\",\n \"cpf\": \"22066300877\",\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": "1ac09040-0879-4356-a670-2387edd15b57", "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\": \"PASSPORT\",\n \"cpf\": \"22066300877\",\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": "1dcef6cc-c2a0-41b7-8f7b-b86c542c711e", "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": "f076f4a4-99d8-4abd-a5d4-6ad4720a24c3", "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": "5f5263c9-ed21-41a5-bbfb-3baedd569f6e", "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": "65263721-a604-45ec-9e3b-b239eacd642f", "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": "949e3d9d-c496-45e2-9268-a04160a0fd30", "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": "24617d6e-d8fc-4a0c-b59b-788346db7fe0", "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": "166beda4-c28d-441a-b43c-98598143d0ce", "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": "049de163-0bb9-4db1-988e-3f31cbe6ca3b", "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": "ec1f71fc-670d-491f-b33a-415f415f689c", "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": "add7d2f5-185e-4ebc-8d57-44eaaf8bf29c", "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": "d54a45f8-1747-42f1-abce-cccf092d505e", "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": "1a0b8921-b65a-40ae-ba2d-90e755c45d5e", "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": "87088d7d-932d-4e74-8a76-12e99d7fe517", "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": "97bd0bf5-09ac-4614-bc79-fb389d54d81a", "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": "6ed01f8c-887e-4bdd-bac7-9a443ac3dd9e", "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": "93ce0b73-6968-4697-b18e-3d498bf56127", "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": "0f5fa62c-e2f6-401c-8c6c-e4811e39c56b", "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": "d060ced9-c477-4176-9878-7179ac47b197", "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": "3fbfe6c0-04f6-4205-ac45-9a06e7173499", "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": "bdd91fb3-55df-4253-8b90-e574d4aa57d7", "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": "ee24cce8-72ad-49f9-aed9-fc240d2c17c1", "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": "121664d8-c04b-430f-a67d-29a6108f4d5d", "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": "d6951a27-d37e-40be-b85b-38123ecddc17", "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": "550ddbdf-cf15-496b-b325-ff28b363716b", "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": "ca21945c-c6e2-48da-bf9d-ecf4a81cee84", "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": "ec45e6a3-0a0d-4abc-93ba-617943c8e52c", "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": "804ee339-53ae-4b4c-9718-02979e091e96", "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": "340f0af9-123a-4ff5-a318-8900a700511e", "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": "d3c5f726-a9d6-4f4c-8911-8208e1243957", "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": "b2eba3a1-5693-46d9-9602-43c30df5e39e", "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": "4ed450be-44e9-4ce5-939e-76b7c2bb4eb1", "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": "dbdbacc8-ee0f-4f41-a943-754ce4a7a9f5", "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": "45baab74-ac88-4aed-89dd-5763387e1616", "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": "30b8bee1-e9ca-4bad-b3bf-4f2bddc68b5c", "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\": \"DOCUMENT_SIGNATURE\",\n \"evidenceHash\": \"\",\n \"policy\": {\n \"profile\": \"DIGITAL_CERTIFICATE\",\n \"customSteps\": [\n \"CLICK_ACCEPT\",\n \"SERPRO_IDENTITY_CHECK\"\n ]\n },\n \"steps\": [\n {\n \"type\": \"OTP_CHALLENGE\",\n \"status\": \"FAILED\",\n \"order\": \"\",\n \"completedAt\": \"\"\n },\n {\n \"type\": \"SERPRO_IDENTITY_CHECK\",\n \"status\": \"STARTED\",\n \"order\": \"\",\n \"completedAt\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"completedAt\": \"\",\n \"documentHash\": \"\",\n \"signer\": {\n \"displayName\": \"\"\n },\n \"tenantName\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9710e6a-52b7-46ac-903e-a4c24c193476", "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": "4c149fc6-5cff-423c-be71-a9da04d162b1", "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": "38a320ae-7277-4342-b570-c0540767c976", "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 \"evidencePack\": {\n \"url\": \"\",\n \"filename\": \"\"\n },\n \"signedPdf\": {\n \"url\": \"\",\n \"filename\": \"\"\n },\n \"finalPdf\": {\n \"url\": \"\",\n \"filename\": \"\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5b8d819d-bdc9-4a20-a834-58299ce3890a", "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": "5a7c855c-8bc4-408f-b0ac-85405f270b4f", "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": "e0483f94-da39-488c-b580-bdbca6349de6", "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.CANCELLED\"\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 \"API.DEPRECATION_NOTICE\",\n \"STEP.FAILED\"\n ],\n \"status\": \"ACTIVE\",\n \"createdAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "46d85009-5ee5-42f5-be5c-19e3908c5e6a", "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.CANCELLED\"\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": "69f77552-4d03-4098-9ee6-5a6827402116", "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.CANCELLED\"\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": "22cd276a-32b1-4b9d-b77a-699e2a47b061", "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.CANCELLED\"\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": "8848ad30-85d0-4278-bead-8f37c6a3ccc2", "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.CANCELLED\"\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": "cd04bab7-1839-4864-9713-ef138994b4fc", "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.CANCELLED\"\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": "406ca3b2-56b6-409c-ba1d-18ce0098f6e8", "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": "cddbbb14-c544-4324-9584-483ed0e07de2", "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.CREATED\",\n \"STEP.STARTED\"\n ],\n \"status\": \"ACTIVE\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"webhookId\": \"\",\n \"url\": \"\",\n \"events\": [\n \"TRANSACTION.FAILED\",\n \"STEP.COMPLETED\"\n ],\n \"status\": \"ACTIVE\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"count\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "583a8db2-73cb-4f4a-95ea-8c3870f8c4e5", "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": "0826775b-9d91-43a6-8e53-12a65cf60801", "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": "313de282-6280-40e5-923e-82c2edeb1e83", "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": "f71337f5-84d8-4e9d-969d-03717ccea0d1", "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": "04511daf-427e-422a-8780-a7be2446ea4f", "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": "544a0f92-809f-40b9-8845-b9cf649407d7", "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": "f5e6f25d-0877-4985-ac02-42fa5feb6f72", "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": "bda73ed1-9625-4eb6-a8fb-7326665c198d", "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": "eded4854-9045-4149-900d-be8e1d6af54b", "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": "5e1eb605-3125-4fc6-b376-2cc037ad4670", "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": "6e97db8d-ba81-4d10-9f32-cb2c9e6fc16e", "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": "fc05d321-7d5e-41cf-9393-d6c097dbca1d", "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": "b208bdfb-1bb3-4f01-891d-14d859fae43b", "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": "dd7404c3-0db6-4688-869a-c660582f6d2f", "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": "adc3c170-89f9-4fb9-ae49-b060ff63b342", "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": "dd608b7f-a4a8-4a51-989d-6bbb71f3edb4", "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": "88bb01aa-301f-4c58-bdce-2b9dddb49656", "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\": \"42212920917\",\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\": \"DOCUMENT_PHOTO\",\n \"enrolledAt\": \"\",\n \"cpf\": \"\",\n \"faceConfidence\": \"\",\n \"documentImageHash\": \"\",\n \"extractionConfidence\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a1aae74-7b02-4587-b078-6752d8810848", "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\": \"42212920917\",\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": "9f493b5f-0b41-47da-99ed-cd88659ae121", "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\": \"42212920917\",\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": "1eafa785-516c-4ad4-a0d8-58c376224882", "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\": \"42212920917\",\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": "94d96a78-52c2-4b52-890e-35eaf6c9c139", "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\": \"42212920917\",\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": "70634197-193c-4868-862b-3b3ea43f07f3", "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\": \"42212920917\",\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": "581897d6-f57b-492f-a005-d1bef983d60e", "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\": \"CUSTOM\",\n \"customSteps\": [\n \"CLICK_ACCEPT\",\n \"DIGITAL_SIGN_A1\"\n ]\n },\n \"signer\": {\n \"cpf\": 422\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\": \"#BA7E2B\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#3DfE2e\",\n \"textColor\": \"#6cfCA5\",\n \"buttonTextColor\": \"#5f8dBc\",\n \"borderRadius\": \"735px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "4d923cbc-6054-441f-a951-1bda5320dc57", "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\": \"CUSTOM\",\n \"customSteps\": [\n \"CLICK_ACCEPT\",\n \"DIGITAL_SIGN_A1\"\n ]\n },\n \"signer\": {\n \"cpf\": 422\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\": \"#BA7E2B\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#3DfE2e\",\n \"textColor\": \"#6cfCA5\",\n \"buttonTextColor\": \"#5f8dBc\",\n \"borderRadius\": \"735px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "RateLimit-Reset", "value": "" }, { "disabled": false, "description": { "content": "URL do recurso criado.", "type": "text/plain" }, "key": "Location", "value": "" } ], "body": "{\n \"sessionId\": \"\",\n \"transactionId\": \"\",\n \"status\": \"ACTIVE\",\n \"url\": \"\",\n \"clientSecret\": \"\",\n \"expiresAt\": \"\",\n \"createdAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f506094-9c45-473e-a086-a8600a5e7842", "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\": \"CUSTOM\",\n \"customSteps\": [\n \"CLICK_ACCEPT\",\n \"DIGITAL_SIGN_A1\"\n ]\n },\n \"signer\": {\n \"cpf\": 422\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\": \"#BA7E2B\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#3DfE2e\",\n \"textColor\": \"#6cfCA5\",\n \"buttonTextColor\": \"#5f8dBc\",\n \"borderRadius\": \"735px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\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": "553f39d6-e8b7-4977-bb7f-937e82ff6742", "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\": \"CUSTOM\",\n \"customSteps\": [\n \"CLICK_ACCEPT\",\n \"DIGITAL_SIGN_A1\"\n ]\n },\n \"signer\": {\n \"cpf\": 422\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\": \"#BA7E2B\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#3DfE2e\",\n \"textColor\": \"#6cfCA5\",\n \"buttonTextColor\": \"#5f8dBc\",\n \"borderRadius\": \"735px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\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": "f287765f-5b2a-4334-a8d3-243b147fc405", "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\": \"CUSTOM\",\n \"customSteps\": [\n \"CLICK_ACCEPT\",\n \"DIGITAL_SIGN_A1\"\n ]\n },\n \"signer\": {\n \"cpf\": 422\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\": \"#BA7E2B\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#3DfE2e\",\n \"textColor\": \"#6cfCA5\",\n \"buttonTextColor\": \"#5f8dBc\",\n \"borderRadius\": \"735px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\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": "650a78d4-bae0-4c77-8683-54b007550aad", "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\": \"CUSTOM\",\n \"customSteps\": [\n \"CLICK_ACCEPT\",\n \"DIGITAL_SIGN_A1\"\n ]\n },\n \"signer\": {\n \"cpf\": 422\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\": \"#BA7E2B\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#3DfE2e\",\n \"textColor\": \"#6cfCA5\",\n \"buttonTextColor\": \"#5f8dBc\",\n \"borderRadius\": \"735px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\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": "f49170d8-d274-4ec9-a2d8-82001a639232", "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\": \"CUSTOM\",\n \"customSteps\": [\n \"CLICK_ACCEPT\",\n \"DIGITAL_SIGN_A1\"\n ]\n },\n \"signer\": {\n \"cpf\": 422\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\": \"#BA7E2B\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#3DfE2e\",\n \"textColor\": \"#6cfCA5\",\n \"buttonTextColor\": \"#5f8dBc\",\n \"borderRadius\": \"735px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\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": "5c43bf0c-c997-4caa-bc5e-71a64c24ff0e", "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\": \"CUSTOM\",\n \"customSteps\": [\n \"CLICK_ACCEPT\",\n \"DIGITAL_SIGN_A1\"\n ]\n },\n \"signer\": {\n \"cpf\": 422\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\": \"#BA7E2B\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#3DfE2e\",\n \"textColor\": \"#6cfCA5\",\n \"buttonTextColor\": \"#5f8dBc\",\n \"borderRadius\": \"735px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\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": "6e7b3530-f91a-488b-b77c-1d679c174aa9", "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\": \"CUSTOM\",\n \"customSteps\": [\n \"CLICK_ACCEPT\",\n \"DIGITAL_SIGN_A1\"\n ]\n },\n \"signer\": {\n \"cpf\": 422\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\": \"#BA7E2B\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#3DfE2e\",\n \"textColor\": \"#6cfCA5\",\n \"buttonTextColor\": \"#5f8dBc\",\n \"borderRadius\": \"735px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\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": "d55922fb-aaa1-4d2e-addb-84682a46c13d", "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": "FAILED" }, { "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": "c1e8c627-9bfb-4196-9c6a-300989fbc906", "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": "FAILED" }, { "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\": \"CANCELLED\",\n \"createdAt\": \"\",\n \"expiresAt\": \"\",\n \"locale\": \"\"\n },\n {\n \"sessionId\": \"\",\n \"transactionId\": \"\",\n \"status\": \"FAILED\",\n \"createdAt\": \"\",\n \"expiresAt\": \"\",\n \"locale\": \"\"\n }\n ],\n \"nextCursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0e5e603-7aa2-4e56-96a9-4509db5494f2", "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": "FAILED" }, { "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": "226efd44-7ee2-4c88-b3b7-026615ad310e", "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": "FAILED" }, { "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": "326f5c2d-5f95-4ac8-a517-123dbcabe165", "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": "FAILED" }, { "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": "2177eb03-7800-40b0-b707-c144f856e23c", "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": "FAILED" }, { "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": "dd5e16fb-2689-42f6-a9cb-098156ae9309", "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": "0441ecbb-85cd-4766-9fa6-11d463978ec3", "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\": \"CANCELLED\",\n \"purpose\": \"DOCUMENT_SIGNATURE\",\n \"signer\": {\n \"name\": \"\",\n \"maskedEmail\": \"\",\n \"maskedCpf\": \"\"\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\": \"#B3860a\",\n \"logoUrl\": \"\",\n \"companyName\": \"\",\n \"backgroundColor\": \"#cD3975\",\n \"textColor\": \"#5c0abB\",\n \"buttonTextColor\": \"#9Fa57A\",\n \"borderRadius\": \"4401902px\",\n \"headerStyle\": \"full\",\n \"fontFamily\": \"system-ui\"\n },\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eee64fe3-5d00-4761-8152-7d253273284b", "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": "f5c47a2a-e8d9-46ee-8082-e567e0ed4c35", "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": "31fcf9cf-73a8-4c37-8574-d9fd7b925a04", "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": "703c2802-5d6c-4ab3-9ee3-7c884f0cc8a9", "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": "f26d8084-fc54-4eed-ac92-db64dd9f922a", "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\": \"start_liveness\",\n \"otpCode\": \"\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"CELL\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "8b9cb5ab-5a8b-4d20-9398-d8c2f4907aad", "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\": \"start_liveness\",\n \"otpCode\": \"\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"CELL\"\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\": \"ACTIVE\",\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": "03a45833-7256-48a9-98c7-0839509524ae", "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\": \"start_liveness\",\n \"otpCode\": \"\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"CELL\"\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": "8f27a03d-0fdf-4f96-8ba3-9404f595f5a9", "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\": \"start_liveness\",\n \"otpCode\": \"\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"CELL\"\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": "aae35dc2-60fa-4370-90e1-901bb29466cc", "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\": \"start_liveness\",\n \"otpCode\": \"\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"CELL\"\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": "6ad794f3-df81-4ded-973e-c3c503f15302", "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\": \"start_liveness\",\n \"otpCode\": \"\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"CELL\"\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": "c3258eed-66f4-47e9-881d-79a9604cc277", "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\": \"start_liveness\",\n \"otpCode\": \"\",\n \"livenessSessionId\": \"\",\n \"certificateChainPems\": [\n \"\",\n \"\"\n ],\n \"signatureRequestId\": \"\",\n \"rawSignatureBase64\": \"\",\n \"geolocation\": {\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"accuracy\": \"\",\n \"source\": \"CELL\"\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": "76935c17-b009-4283-b2ea-796831718208", "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": "c4f634dc-7406-47c0-a89f-561a758549a1", "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\": \"ACTIVE\",\n \"completedAt\": \"\",\n \"evidenceId\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72562d08-b541-49ea-be7c-f8a016d23f06", "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": "b5e38bcd-696d-4c64-b5c9-e63dfe9969eb", "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": "348ccff4-2be3-4fda-b7eb-94700e31cc24", "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": "d23384f5-7ad2-445a-9ba0-56949aac2125", "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": "3118d190-0f63-4002-9a41-5d1a50f69638", "name": "Sessão cancelada com sucesso.", "originalRequest": { "url": { "path": [ "v1", "signing-sessions", ":sessionId", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Identificador único da sessão de assinatura.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Strict-Transport-Security", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Content-Type-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Frame-Options", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Referrer-Policy", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "API-Version", "value": "" } ], "body": "{\n \"sessionId\": \"\",\n \"transactionId\": \"\",\n \"status\": \"COMPLETED\",\n \"cancelledAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "301dba93-52fa-4322-a006-83a31e980f03", "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": "6fb02538-32b6-4157-bebc-74d815ddd5f9", "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": "271393f1-28c1-462a-89dd-53e8d101407f", "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": "fc3abf49-ecc8-411b-86a3-d90ac769229c", "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": "c1b974c4-a8e6-4a11-895e-7e4d02042181", "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\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": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "1d1f2acf-a89d-4b2a-b03e-ab6d0e4fe310", "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": "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 \"status\": \"ACTIVE\",\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": "255c8c34-a09d-475e-bd54-26a89e9d92fa", "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": "Accept", "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": "5d538aab-7069-4b73-8bf4-da3645bcb218", "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": "Accept", "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": "cd39cc94-a4c3-4274-be13-bcced7c17434", "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": "Accept", "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": "9c38d9f2-bae6-4cfd-8bb2-f714db162dc5", "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": "Accept", "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": "615cffdd-c94e-452d-819a-2f4bb042727d", "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": "Accept", "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": "11. Envelopes", "description": "Crie envelopes para assinatura com múltiplos signatários, adicione sessões e gere carimbo combinado.", "item": [ { "id": "7dcdf26d-ab99-4eeb-a6b3-95e0511ed1f2", "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\": \"SEQUENTIAL\",\n \"totalSigners\": \"\",\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 1440\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{access_token}}" } ] } }, "response": [ { "id": "4dd8ea28-0718-414b-8847-b9b2593517e6", "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\": \"SEQUENTIAL\",\n \"totalSigners\": \"\",\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 1440\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\": \"ACTIVE\",\n \"signingMode\": \"PARALLEL\",\n \"totalSigners\": \"\",\n \"documentHash\": \"\",\n \"createdAt\": \"\",\n \"expiresAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6be21d4c-ca99-4069-9999-cb480acb2a1f", "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\": \"SEQUENTIAL\",\n \"totalSigners\": \"\",\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 1440\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": "5081b397-cd8a-4bb5-8cc1-c57accc66093", "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\": \"SEQUENTIAL\",\n \"totalSigners\": \"\",\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 1440\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": "4a0e13db-5a54-4fad-9244-c06e3755351c", "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\": \"SEQUENTIAL\",\n \"totalSigners\": \"\",\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 1440\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": "3efb38b5-00f1-4a49-9d95-8f4f8fd70261", "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\": \"SEQUENTIAL\",\n \"totalSigners\": \"\",\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 1440\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": "f3659302-6a44-41a3-a744-1556c197c790", "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\": \"SEQUENTIAL\",\n \"totalSigners\": \"\",\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 1440\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": "f33efb5d-d1b9-40c9-9485-99ca762d84bd", "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\": \"SEQUENTIAL\",\n \"totalSigners\": \"\",\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 1440\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": "bf2817c4-1808-4376-9150-c7ac5af59dc7", "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\": \"SEQUENTIAL\",\n \"totalSigners\": \"\",\n \"document\": {\n \"content\": \"\",\n \"filename\": \"\"\n },\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"locale\": \"pt-BR\",\n \"returnUrl\": \"\",\n \"cancelUrl\": \"\",\n \"expiresInMinutes\": 1440\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": "0659f197-eb7c-43c5-b411-5f38575e8e0a", "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": "ad1ddde6-2d1b-461b-b0c1-5585632ce497", "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\": \"ACTIVE\",\n \"signingMode\": \"SEQUENTIAL\",\n \"totalSigners\": \"\",\n \"addedSessions\": \"\",\n \"completedSessions\": \"\",\n \"documentHash\": \"\",\n \"sessions\": [\n {\n \"sessionId\": \"\",\n \"transactionId\": \"\",\n \"signerIndex\": \"\",\n \"signerName\": \"\",\n \"status\": \"CANCELLED\",\n \"completedAt\": \"\",\n \"evidenceId\": \"\"\n },\n {\n \"sessionId\": \"\",\n \"transactionId\": \"\",\n \"signerIndex\": \"\",\n \"signerName\": \"\",\n \"status\": \"CANCELLED\",\n \"completedAt\": \"\",\n \"evidenceId\": \"\"\n }\n ],\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"expiresAt\": \"\",\n \"combinedSignedPdfUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c490c901-516f-4812-a511-88f8ff241753", "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": "f360e54b-5d82-4e1e-a72c-91d8e4151461", "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": "8179121e-5f1b-4575-91a5-503501ddf120", "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": "3a50f024-c8f2-4434-879a-0dc9fbb36836", "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": "c4f32e4a-b813-48bf-838c-c6e38f21c16d", "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": "e8840cb2-ea1c-4dd6-afb7-e1027b640c9b", "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\": 7128.806688182683\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": "ed696d9c-7f64-430a-885e-be1eb360325a", "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\": 7128.806688182683\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\": \"ACTIVE\",\n \"url\": \"\",\n \"clientSecret\": \"\",\n \"expiresAt\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e9192b3-df2a-43ed-9102-cf7c2cee050c", "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\": 7128.806688182683\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": "e3787001-d9c0-4da9-8cde-f20bf6627b11", "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\": 7128.806688182683\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": "081509d7-2567-4970-b0de-e65b104ff43f", "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\": 7128.806688182683\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": "41a9d305-581a-4feb-b359-f30571de3e51", "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\": 7128.806688182683\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": "5b2b9a86-50a7-4d67-bce7-25e22004df20", "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\": 7128.806688182683\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": "cebf491c-fd8b-4d86-b9cc-436f97782dbb", "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\": 7128.806688182683\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": "17b80e98-47ff-4a45-a8cc-893da46ef8ac", "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\": 7128.806688182683\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": "05e52284-50e4-49fd-ba31-24f079d04ba8", "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\": 7128.806688182683\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": "b543fa8d-987e-4ea7-9a54-5e0723462302", "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": "7ba0e0a3-4d8f-4d4d-b10b-0606f0aa3cd5", "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": "f38b683b-f5c0-4b13-ac28-c076027138f7", "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": "ad40f8cc-dd95-4d7d-b3a2-d2caa8ef1d48", "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": "4f38be28-001d-4e99-ba14-406e0318c006", "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": "0b8d363b-260d-4409-a05c-424d3e929496", "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": "497edb9b-e629-45af-8e4d-0df53a05a65f", "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": "8080b237-4d6a-4cdf-81bd-ecbaf12a3b92", "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": "dfda427a-9602-4b78-b53e-93555efda3e4", "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": "46c2a551-0bba-4d4e-929a-9ecf7e09718a", "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": "679811da-6999-421a-9983-fb6aec75d027", "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": "264148b9-de3f-4610-9364-cb10ac8e7d99", "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": "26ca12cb-ae73-47e5-8362-bb0c89879a5c", "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": "d5984d58-0b78-4a36-a68c-c56b5619bde5", "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": "c650aa9d-9c45-4a40-9dd6-023603954f30", "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": "f5965282-7434-4680-97a7-eca30bc8f361", "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": "31c1cdd4-6ea2-4a7d-8f95-ae492c51fbb1", "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\": \"down\",\n \"latencyMs\": \"\"\n },\n \"mtlsTruststore\": {\n \"status\": \"operational\",\n \"latencyMs\": \"\"\n }\n },\n \"latencyMs\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8b455999-8dca-439f-9715-61d524803c93", "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": "41bd82a0-7e26-431d-96be-614bbeeb9de2", "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": "ffede0a3-5b98-40b1-8d9a-ed13ed7ec488", "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": "814b0c33-9643-44ea-8433-7cfd75b0cd8e", "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": "3bee262f-b509-4d45-a0fe-a3e10b15c742", "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\": \"24h\",\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\": \"operational\",\n \"latencyMs\": \"\"\n },\n \"mtlsTruststore\": {\n \"status\": \"down\",\n \"latencyMs\": \"\"\n }\n },\n \"checkedAt\": \"\",\n \"totalLatencyMs\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21ac066a-4d9c-4d73-8106-bdfb1eab9b44", "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": "7894f3c2-dcda-407e-b6b7-df18470928ab", "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": "4d180b4d-3d9e-4470-8603-81e2571d6ebd", "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" } } }