Upload a file directly into the Vault (statements, documents)

POST

/v1/vault/objects

const url = 'https://api.trustysweep.com/v1/vault/objects';
const form = new FormData();
form.append('file', 'file');
form.append('name', 'example');
form.append('kind', 'statement');

const options = {method: 'POST', headers: {cookie: 'sweep_session=<sweep_session>'}};

options.body = form;

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.trustysweep.com/v1/vault/objects \
  --header 'Content-Type: multipart/form-data' \
  --cookie sweep_session=<sweep_session> \
  --form file=@file \
  --form name=example \
  --form kind=statement

Authorizations

sessionCookie
sessionToken
apiKey
vault:write
oauth2
vault:write

Parameters

Header Parameters

Idempotency-Key

string

<= 255 characters

Unique key per logical operation. Same key + same body within 24h replays the original response with Idempotent-Replayed: true; same key + different body → 409 idempotency_key_reused.

Request Body^required

multipart/form-data

object

file

required

string format: binary

name

string

kind

string

Allowed values: statement file

Responses

201

Created

application/json

object

required

Prefixed ULID (vlt_…)

string

/^vlt_[0-9A-HJKMNP-TV-Z]{26}$/

asset_id

One of:

string
null

Prefixed ULID (ast_…)

string

/^ast_[0-9A-HJKMNP-TV-Z]{26}$/

name

One of:

string
null

string

provider

One of:

string
null

string

Allowed values: google_gmail google_drive microsoft_outlook microsoft_onedrive dropbox apple_local s3_compatible trusty_vault simulated

source_id

One of:

string
null

Prefixed ULID (src_…)

string

/^src_[0-9A-HJKMNP-TV-Z]{26}$/

sha256

required

string

size_bytes

required

integer

mime_type

One of:

string
null

string

state

required

string

Allowed values: uploading verifying committed corrupt deleting deleted cold

created_at

required

string format: date-time

verified_at

One of:

string
null

string format: date-time

cold_since

One of:

string
null

string format: date-time

has_text

boolean

has_ocr

boolean

manifest_id

One of:

string
null

Prefixed ULID (mfs_…)

string

/^mfs_[0-9A-HJKMNP-TV-Z]{26}$/

Example

{
  "id": "vlt_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
  "asset_id": "ast_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
  "provider": "google_gmail",
  "source_id": "src_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
  "state": "uploading",
  "manifest_id": "mfs_01J8Z3K9M2Q4R6S8T0V2W4X6Y8"
}

Headers

RateLimit-Limit

integer

Requests allowed in the current window.

RateLimit-Remaining

integer

Requests remaining in the current window.

RateLimit-Reset

integer

Seconds until the window resets.

400

Validation failed

application/problem+json

RFC 9457 problem details.

object

type

required

Https://developers.trustysweep.com/errors/

string format: uri

titlerequired

string

statusrequired

integer

detail

string

coderequired

Machine-readable error code from errors.json

string

request_idrequired

string

errors

Array<object>

object

pathrequired

string

messagerequired

string

`Example^generated`

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`401`

Section titled “401”

Unauthenticated

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`403`

Section titled “403”

Forbidden / action denied / step-up required

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`404`

Section titled “404”

Not found

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`409`

Section titled “409”

Conflict (state, stale plan, idempotency key reuse)

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`429`

Section titled “429”

Rate limited

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

`Headers`

Section titled “Headers”

Retry-After

integer

Seconds to wait before retrying.

RateLimit-Limit

integer

Requests allowed in the current window.

RateLimit-Remaining

integer

Requests remaining in the current window.

RateLimit-Reset

integer

Seconds until the window resets.

`500`

Section titled “500”

Internal error

Media typeapplication/problem+json
RFC 9457 problem details.
object
typerequired
Https://developers.trustysweep.com/errors/

string format: uri
titlerequired
string
statusrequired
integer
detail
string
coderequired
Machine-readable error code from errors.json

string
request_idrequired
string
errors
Array<object>
object
pathrequired
string
messagerequired
string
Example^generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

Upload a file directly into the Vault (statements, documents)

Authorizations

Parameters

Header Parameters

Request Bodyrequired

Responses

201

Example

Headers

400

Examplegenerated

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

429

Examplegenerated

Headers

500

Examplegenerated

Request Body^required

`Example^generated`

`401`

`Example^generated`

`403`

`Example^generated`

`404`

`Example^generated`

`409`

`Example^generated`

`429`

`Example^generated`

`Headers`

`500`

`Example^generated`