Create a shared file request configuration

post

https://api.wingspan.app/v3/compliance/shared-file-request-configurations

Creates an upload configuration owned by the calling account. The returned id is what a RequirementType: DocumentUpload requirement definition passes as dataSourceId.

Supplying an externalId already in use for this account returns 409 ResourceConflict — create is not an upsert. Recover by listing with ?filter[externalId][eq]= to retrieve the existing configuration.

A non-None contextType is at most one per account, because it selects the automated extraction and validation that runs on the upload. A second create with the same one returns 409 ResourceConflict; retrieve the existing configuration with ?filter[contextType][eq]=. Any number of None configurations (a plain file-type check) is allowed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

externalId

string

Caller-supplied reconciliation id, unique per account. A duplicate returns 409 ResourceConflict.

title

string

required

instructions

string

acceptedMimeTypes

array of strings

acceptedMimeTypes

contextType

string

enum

Defaults to None (a file-type check only, completing immediately). Create-only — see the resource field.

Allowed:

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

Idempotency-Key

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.

X-Wingspan-Account

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).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201Shared file request configuration created

400Malformed request syntax

401Unauthenticated

403Forbidden

409Conflict

422Validation error