API Reference

Create a signature request for a vault file

post
https://api.wingspan.app/v3/compliance/vault-files//signature-requests

Create a one-off signature request with its own signer list, using this path's fileId as the unsigned source.

To open a request against a DocumentTemplate, authorised by the requirement the caller names, use POST /compliance/signature-requests.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the vault file

Body Params

DEFERRED — the body of createVaultFileSignatureRequest, which returns 501 NotImplemented. This is the caller-composed ONE-OFF: its own signer list, its own unsigned source file, and no V1 path behind it. The schema stays declared so the shape does not have to be re-agreed when it lands.

NOT the template-backed create, which IS implemented and takes SignatureRequestFromTemplateCreate.

string

Optional DocumentTemplate to use for signing defaults. For nested creation the target is the path fileId; for template generation the target is the generated vault file.

string
string

Optional message included with the request

signers
array of objects
required
signers*
string

Associate with a specific payee

metadata
object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers
string
length between 1 and 255
^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/problem+json

Updated about 1 month ago

Did this page help you?