The transaction to add the files to
| | | **fileId** | path | string | Yes |A unique identifier for the file within the transaction. Must not exceed 255 characters and cannot contain control characters or the following special characters: :, \*, ?, \, /, ", \<, >, | , or null characters.
Content type - either application/pdf for file upload or application/json for metadata
| | | **Digest** | header | string | No |SHA-256 or SHA-512 checksum of the PDF file for integrity verification (only for PDF uploads)
| | ## Request Body (required) Either PDF file content or file metadata JSON #### application/json Content-Type: `application/json` **Schema:** [FileMetadata](/openapi/models/FileMetadata.md) #### Properties | Name | Type | Description | | | ---------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **DisplayName** | String | Null |Human-readable display name for the file that will be shown to users in the signing interface. If not provided, the fileId will be used as the display name.
| | **DisplayOrder** | Integer | Null |Numeric value determining the order in which files are displayed and processed when multiple files are present in a transaction. Lower numbers appear first. If not specified, a timestamp-based order is used.
| | **Description** | String | Null |Detailed description of the file's purpose and contents. This helps users understand what they are signing and may be displayed in the signing interface or audit logs.
| | **SetParaph** | Boolean | Null |Indicates whether a paraph (initial) should be set on each page of the document in addition to the main signature. When true, signers will be required to initial every page. Defaults to false if not specified.
| | **Signers** | Object |Dictionary mapping signer identifiers to their specific configuration for this file. Each signer can have different form sets and signing requirements for the same document. The key is the signer identifier.
| | | **FormSets** | Object |Nested dictionary structure defining form fields and signing areas within the document. The outer key represents the form set name, and the inner key represents individual field identifiers within that set. Form sets allow grouping related fields together for organization and signer assignment.
The following characters are allowed as a key / field name: a-z A-Z 0-9 \_.
Map of pdf field definitions.
| | #### application/pdf Content-Type: `application/pdf` **Type:** string ## Responses ### 200 File was updated successfully (PDF upload) Content-Type: `application/json` #### Properties | Name | Type | Description | | ----------- | ------ | ----------- | | **Message** | String | | ### 201 New file was created successfully (PDF upload) Content-Type: `application/json` #### Properties | Name | Type | Description | | ----------- | ------ | ----------- | | **Message** | String | | ### 202 Metadata accepted, waiting for actual file (metadata upload) Content-Type: `application/json` #### Properties | Name | Type | Description | | ----------- | ------ | ----------- | | **Message** | String | | ### 400 Bad request - validation error, digest mismatch, or invalid JSON Content-Type: `application/json` **Schema:** [ErrorResponse](/openapi/models/ErrorResponse.md) #### Properties | Name | Type | Description | | ------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **type** | String |A URI reference identifying the problem type. This property is always present in RFC 7807 responses.
| | **title** | String |A short, human-readable summary of the problem
| | **detail** | String |A human-readable explanation specific to this occurrence of the problem
| | **status** | Integer |The HTTP status code
| | **instance** | String |A URI reference that identifies the specific occurrence of the problem
| | **Message** | String |Deprecated (Legacy Format Only): Contains the error message in the old response format. This property appears alone in legacy error responses and is mutually exclusive with the RFC 7807 properties above. Will be phased out as we complete our transition to RFC 7807.
| **Examples:** _digestMismatch:_ ```json { "Message": "SHA-256 digest mismatch" } ``` _unsupportedAlgorithm:_ ```json { "Message": "Hash algorithm [MD5] is not supported." } ``` _invalidFileId:_ ```json { "Message": "FileId is invalid" } ``` _signerNotFound:_ ```json { "Message": "Signer 'signer1' not found." } ``` _missingContentType:_ ```json { "Message": "Unexpected or missing Content-Type header, did you specify 'application/pdf'?" } ``` _invalidJson:_ ```json { "Message": "Invalid json structure provided." } ``` ### 401 Unauthorized - user not creator of transaction Content-Type: `application/json` **Schema:** [ErrorResponse](/openapi/models/ErrorResponse.md) #### Properties | Name | Type | Description | | ------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **type** | String |A URI reference identifying the problem type. This property is always present in RFC 7807 responses.
| | **title** | String |A short, human-readable summary of the problem
| | **detail** | String |A human-readable explanation specific to this occurrence of the problem
| | **status** | Integer |The HTTP status code
| | **instance** | String |A URI reference that identifies the specific occurrence of the problem
| | **Message** | String |Deprecated (Legacy Format Only): Contains the error message in the old response format. This property appears alone in legacy error responses and is mutually exclusive with the RFC 7807 properties above. Will be phased out as we complete our transition to RFC 7807.
| **Example:** ```json { "Message": "Unauthorized access to this resource." } ``` ### 403 Forbidden - authorization policy violation Content-Type: `application/json` **Schema:** [ErrorResponse](/openapi/models/ErrorResponse.md) #### Properties | Name | Type | Description | | ------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **type** | String |A URI reference identifying the problem type. This property is always present in RFC 7807 responses.
| | **title** | String |A short, human-readable summary of the problem
| | **detail** | String |A human-readable explanation specific to this occurrence of the problem
| | **status** | Integer |The HTTP status code
| | **instance** | String |A URI reference that identifies the specific occurrence of the problem
| | **Message** | String |Deprecated (Legacy Format Only): Contains the error message in the old response format. This property appears alone in legacy error responses and is mutually exclusive with the RFC 7807 properties above. Will be phased out as we complete our transition to RFC 7807.
| **Example:** ```json { "Message": "Access denied by authorization policy." } ``` ### 413 Payload too large - file exceeds 50MB limit Content-Type: `application/json` **Schema:** [ErrorResponse](/openapi/models/ErrorResponse.md) #### Properties | Name | Type | Description | | ------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **type** | String |A URI reference identifying the problem type. This property is always present in RFC 7807 responses.
| | **title** | String |A short, human-readable summary of the problem
| | **detail** | String |A human-readable explanation specific to this occurrence of the problem
| | **status** | Integer |The HTTP status code
| | **instance** | String |A URI reference that identifies the specific occurrence of the problem
| | **Message** | String |Deprecated (Legacy Format Only): Contains the error message in the old response format. This property appears alone in legacy error responses and is mutually exclusive with the RFC 7807 properties above. Will be phased out as we complete our transition to RFC 7807.
| **Example:** ```json { "Message": "Request entity too large." } ``` ### 500 Internal server error Content-Type: `application/json` **Schema:** [ErrorResponse](/openapi/models/ErrorResponse.md) #### Properties | Name | Type | Description | | ------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **type** | String |A URI reference identifying the problem type. This property is always present in RFC 7807 responses.
| | **title** | String |A short, human-readable summary of the problem
| | **detail** | String |A human-readable explanation specific to this occurrence of the problem
| | **status** | Integer |The HTTP status code
| | **instance** | String |A URI reference that identifies the specific occurrence of the problem
| | **Message** | String |Deprecated (Legacy Format Only): Contains the error message in the old response format. This property appears alone in legacy error responses and is mutually exclusive with the RFC 7807 properties above. Will be phased out as we complete our transition to RFC 7807.
| **Example:** ```json { "Message": "An internal server error occurred." } ```