API Reference

Generate a document vault file from a template

post
https://api.wingspan.app/v3/compliance/document-templates//vault-files

Render a document template into a vault file, optionally opening a signature request against the result.

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

Unique identifier of the document template

Body Params
fieldValues
object

Values merged into the template before rendering.

string

Optional title for the generated vault file.

string

Optional document category for the generated document-kind vault file.

string

Associate the generated vault file with a payee.

signatureRequest
object

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.

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 5 months 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 5 months ago

Did this page help you?