Skip to content
Sanmopia Modernization

Issue settlement data-room signed download handoff

Switch to Zen Mode
POST
/settlement-data-room-requests/{settlementDataRoomRequestId}/download-handoffs
curl --request POST \
  --url https://example.com/settlement-data-room-requests/example/download-handoffs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "actorKind": "headquarters_administrator", "actorProfileId": "example", "idempotencyKey": "example", "expectedRevision": 1, "expiresInSeconds": 1 }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
settlementDataRoomRequestId
required
string
>= 1 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
IssueSettlementDataRoomDownloadHandoffRequest
object
actorKind
required
string
Allowed values: headquarters_administrator branch_manager
actorProfileId
required
string
>= 1 characters
idempotencyKey
required
string
>= 1 characters
expectedRevision
required
integer
>= 1
expiresInSeconds
required
integer
>= 1
key
additional properties

Responses

Section titled “Responses”

200

Section titled “200”

Settlement data-room request plus short-lived signed download handoff

Media typeapplication/json
SettlementDataRoomDownloadHandoffResponse
object
request
required
SettlementDataRoomRequest
object
requestId
required
string
>= 1 characters
requestCode
required
string
>= 1 characters
scope
required
object
collection
required
string
Allowed values: external_counterparty_settlement branch_to_headquarters_settlement headquarters_settlement inter_office_settlement
settlementPeriodStart
required
string format: date
settlementPeriodEnd
required
string format: date
branchProfileId
required
string | null
>= 1 characters
externalRecipientCode
required
string | null
>= 1 characters
sourceDatasetRevision
required
integer
>= 1
sourceEvidenceKeys
required
Array<string>
key
additional properties
status
required
string
Allowed values: requested building ready failed superseded cancelled
revision
required
integer
>= 1
requestedByActorProfileId
required
string
>= 1 characters
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
artifacts
required
Array<object>
object
artifactId
required
string
>= 1 characters
artifactKind
required
string
Allowed values: reconciliation_export download_package repair_result
storageBucket
required
Allowed value: business-report-exports
storageObjectKey
required
string
>= 1 characters
exportFormat
required
string
Allowed values: csv xlsx json
fileName
required
string
>= 1 characters
byteSize
required
integer
>= 1
contentSha256
required
string
>= 1 characters
generatedAt
required
string format: date-time
sourceDatasetRevision
required
integer
>= 1
supersededAt
required
string | null format: date-time
key
additional properties
actionJournal
required
Array<object>
object
actionId
required
string
>= 1 characters
actionKind
required
string
Allowed values: request_export start_build mark_ready mark_failed request_repair issue_download_link cancel_request
actorKind
required
string
Allowed values: headquarters_administrator branch_manager system_workflow
actorProfileId
required
string
>= 1 characters
idempotencyKey
required
string
>= 1 characters
expectedRevision
required
integer
committedRevision
required
integer
>= 1
recordedAt
required
string format: date-time
reason
required
string | null
>= 1 characters
artifactId
required
string | null
>= 1 characters
metadata
required
object
key
additional properties
key
additional properties
key
additional properties
handoff
required
object
requestId
required
string
>= 1 characters
requestCode
required
string
>= 1 characters
artifactId
required
string
>= 1 characters
exportFormat
required
string
Allowed values: csv xlsx json
fileName
required
string
>= 1 characters
byteSize
required
integer
>= 1
contentSha256
required
string
>= 1 characters
signedUrl
required
string
>= 1 characters
expiresAt
required
string format: date-time
issuedActionId
required
string
>= 1 characters
committedRevision
required
integer
>= 1
key
additional properties
key
additional properties

400

Section titled “400”

Settlement data-room download handoff request is invalid

401

Section titled “401”

Supabase bearer token is required

403

Section titled “403”

Actor cannot download settlement data-room artifact

404

Section titled “404”

Settlement data-room request or active artifact not found

409

Section titled “409”

Expected revision is stale

503

Section titled “503”

Settlement data-room storage or request store is unavailable