Skip to content
Trusty Sweep Developers

Get a receipt by id

GET
/v1/receipts/{id}
curl --request GET \
  --url https://api.trustysweep.com/v1/receipts/example \
  --cookie sweep_session=<sweep_session>

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
/^rcp_[0-9A-HJKMNP-TV-Z]{26}$/

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

Durable, tamper-evident execution receipt signed with the platform Ed25519 key published at /.well-known/sweep-receipts.json.

object
receiptVersion
required
string
Allowed values: 1
receiptId
required

Prefixed ULID (rcp_…)

string
/^rcp_[0-9A-HJKMNP-TV-Z]{26}$/
executionId
required

Prefixed ULID (exe_…)

string
/^exe_[0-9A-HJKMNP-TV-Z]{26}$/
planId
required

Prefixed ULID (pln_…)

string
/^pln_[0-9A-HJKMNP-TV-Z]{26}$/
planHash
required
string
tenantRef
required
string
actor
required
object
type
required
string
Allowed values: user sweep_automation developer_application external_agent service connector
principalId
required
string
delegatingUserId
One of:
string
applicationId
One of:
string
agentId
One of:
string
grantId
One of:
string
delegatingUserId
One of:
string
authorization
required
object
actionDecisionId
required
string
grantId
One of:
string
commercialAuthorizationId
One of:
string
policyVersion
required
string
rateCardVersion
One of:
string
intent
required
string
simulated
required
boolean
attempted
required
integer
completed
required
integer
failed
required
integer
objects
required
Array<object>
object
assetId
required
string
providerObjectId
required
string
actions
required
Array<string>
status
required
string
Allowed values: completed partial failed skipped
vaultObjectId
One of:
string
vaultSha256
One of:
string
providerResultId
One of:
string
bytes
integer
error
One of:
string
restorable
boolean
before
required
Array<object>
object
sourceId
required
string
provider
required
string
Allowed values: google_gmail google_drive microsoft_outlook microsoft_onedrive dropbox apple_local s3_compatible trusty_vault simulated
usedBytes
One of:
integer
limitBytes
One of:
integer
observedAt
required
string format: date-time
after
required
Array<object>
object
sourceId
required
string
provider
required
string
Allowed values: google_gmail google_drive microsoft_outlook microsoft_onedrive dropbox apple_local s3_compatible trusty_vault simulated
usedBytes
One of:
integer
limitBytes
One of:
integer
observedAt
required
string format: date-time
bytesPreserved
required
integer
bytesRemoved
required
integer
bytesTransferred
required
integer
measuredReclaimBytes
One of:
integer
charges
required
Array<object>
object
meter
required
string
quantity
required
number
unit
required
string
cents
required
integer
usageEventId
required
string
startedAt
required
string format: date-time
finishedAt
required
string format: date-time
restoration
required
object
capable
required
boolean
until
One of:
string format: date-time
method
One of:
string
errors
Array<string>
hash

Sha256 of canonical JSON of the receipt without hash/signature

string
signature
object
alg
required
string
Allowed values: Ed25519
kid
required
string
sig
required

Base64url Ed25519 signature over hash

string
Example
{
  "receiptVersion": "1",
  "receiptId": "rcp_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
  "executionId": "exe_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
  "planId": "pln_01J8Z3K9M2Q4R6S8T0V2W4X6Y8",
  "actor": {
    "type": "user"
  },
  "objects": [
    {
      "status": "completed"
    }
  ],
  "before": [
    {
      "provider": "google_gmail"
    }
  ],
  "after": [
    {
      "provider": "google_gmail"
    }
  ],
  "signature": {
    "alg": "Ed25519"
  }
}

Headers

Section titled “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

Section titled “400”

Validation failed

Media typeapplication/problem+json

RFC 9457 problem details.

object
type
required

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

string format: uri
title
required
string
status
required
integer
detail
string
code
required

Machine-readable error code from errors.json

string
request_id
required
string
errors
Array<object>
object
path
required
string
message
required
string
Examplegenerated
{
  "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
type
required

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

string format: uri
title
required
string
status
required
integer
detail
string
code
required

Machine-readable error code from errors.json

string
request_id
required
string
errors
Array<object>
object
path
required
string
message
required
string
Examplegenerated
{
  "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
type
required

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

string format: uri
title
required
string
status
required
integer
detail
string
code
required

Machine-readable error code from errors.json

string
request_id
required
string
errors
Array<object>
object
path
required
string
message
required
string
Examplegenerated
{
  "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
type
required

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

string format: uri
title
required
string
status
required
integer
detail
string
code
required

Machine-readable error code from errors.json

string
request_id
required
string
errors
Array<object>
object
path
required
string
message
required
string
Examplegenerated
{
  "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
type
required

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

string format: uri
title
required
string
status
required
integer
detail
string
code
required

Machine-readable error code from errors.json

string
request_id
required
string
errors
Array<object>
object
path
required
string
message
required
string
Examplegenerated
{
  "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
type
required

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

string format: uri
title
required
string
status
required
integer
detail
string
code
required

Machine-readable error code from errors.json

string
request_id
required
string
errors
Array<object>
object
path
required
string
message
required
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}