POST
/
v1
/
files
// POST https://api.signatureapi.com/v1/files
// X-API-Key: key_test_...

{
  "id": "fil_0nZXZ8pYPByQ4XksJbDl4r",
  "put_url": "https://s3.us-east-2.amazonaws.com/signatureapi-vault-dev/temp...",
  "expires_at": "2025-12-31T20:00:00.000Z"
}

Creates a new file that can be used in other parts of this API.

This operation returns a put_url property to which you should upload the file via a PUT request.

Ensure you upload your file as a binary stream. Multipart uploads add content that can render the uploaded file invalid.

After uploading a file, you can reference it in other parts of the API by using its full URL in the URL field. For instance, if the file ID is fil_xxxx1, you can use like this in the creation of a document object:

{
  "url": "https://api.signatureapi.com/v1/files/fil_xxxx1",
  ...
}

This URL is provided in the Location header of the response.

This file is intended for temporary use and expires within 1 hour.

​
Returns

Returns a 201 Created status code along with the following attributes:

id
string

The unique identifier of the file.

put_url
string

The URL to which you should PUT a file to upload it.

expires_at
string

Time at which the file will expire.

// POST https://api.signatureapi.com/v1/files
// X-API-Key: key_test_...

{
  "id": "fil_0nZXZ8pYPByQ4XksJbDl4r",
  "put_url": "https://s3.us-east-2.amazonaws.com/signatureapi-vault-dev/temp...",
  "expires_at": "2025-12-31T20:00:00.000Z"
}

Was this page helpful?

File objectGet a file