@inklok/api-spec 7.11.1 → 7.11.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/openapi.yaml +24 -3
- package/package.json +1 -1
package/openapi.yaml
CHANGED
|
@@ -8,7 +8,7 @@ info:
|
|
|
8
8
|
Authenticate using an API key or bearer token, then use the resources below to manage
|
|
9
9
|
templates, agreements, documents, and signing. For your first integration, start with
|
|
10
10
|
the Quick Start guide.
|
|
11
|
-
version: "7.11.
|
|
11
|
+
version: "7.11.2"
|
|
12
12
|
contact:
|
|
13
13
|
name: Inklok API Support
|
|
14
14
|
email: support@inklok.com
|
|
@@ -3099,12 +3099,29 @@ paths:
|
|
|
3099
3099
|
operationId: getSigningAgreement
|
|
3100
3100
|
summary: Get signing details
|
|
3101
3101
|
description: |
|
|
3102
|
-
Returns the agreement details visible to the
|
|
3103
|
-
the
|
|
3102
|
+
Returns the agreement details visible to the authorized participant. A party-scoped
|
|
3103
|
+
signer bearer token uses the party embedded in the token and requires no query selectors.
|
|
3104
|
+
An authenticated Cognito account may instead supply both `executionId` and `partyId` to
|
|
3105
|
+
read a completed agreement when that exact party is durably bound to the authenticated
|
|
3106
|
+
user. Completed account reads are read-only, expose only the matching USER envelope
|
|
3107
|
+
projection, and never return guest invitation capability secrets.
|
|
3104
3108
|
tags:
|
|
3105
3109
|
- Signing
|
|
3106
3110
|
security:
|
|
3107
3111
|
- bearerAuth: []
|
|
3112
|
+
parameters:
|
|
3113
|
+
- name: executionId
|
|
3114
|
+
in: query
|
|
3115
|
+
required: false
|
|
3116
|
+
description: Required with `partyId` only for authenticated account access to a completed agreement. Ignored for party-scoped signer tokens.
|
|
3117
|
+
schema:
|
|
3118
|
+
type: string
|
|
3119
|
+
- name: partyId
|
|
3120
|
+
in: query
|
|
3121
|
+
required: false
|
|
3122
|
+
description: Required with `executionId` only for authenticated account access. The party must already be durably bound to the authenticated USER.
|
|
3123
|
+
schema:
|
|
3124
|
+
type: string
|
|
3108
3125
|
responses:
|
|
3109
3126
|
'200':
|
|
3110
3127
|
description: Agreement data for signer
|
|
@@ -3243,8 +3260,12 @@ paths:
|
|
|
3243
3260
|
description: JSON-serialized ScopedEncryptedFieldValue (v2). The server stores this string verbatim only after structural and authoritative binding validation.
|
|
3244
3261
|
required:
|
|
3245
3262
|
type: boolean
|
|
3263
|
+
'400':
|
|
3264
|
+
$ref: '#/components/responses/BadRequest'
|
|
3246
3265
|
'401':
|
|
3247
3266
|
$ref: '#/components/responses/Unauthorized'
|
|
3267
|
+
'403':
|
|
3268
|
+
$ref: '#/components/responses/Forbidden'
|
|
3248
3269
|
'500':
|
|
3249
3270
|
$ref: '#/components/responses/InternalServerError'
|
|
3250
3271
|
x-inklok-lambda: signing-get-execution
|