Ctrl+K

Edit a report (Admin only)

patch/api/stablecoin/v1/admin/reports/{reportId}

Updates report metadata; optionally replaces the underlying file by passing the full { fileName, format, fileSize } trio. When the file-replacement trio is supplied the response includes a presigned PUT URL the browser uses to upload the new file directly to S3. Metadata-only edits return just the report shape (no presigned fields).

Path Parameters

  • reportIdstringRequired
    Report identifier
    Example: ec84b11f-491b-465f-a118-403a3485452b

Request Body

title string
Display title for the report
Min length: >= 1 characters
Example: Monthly Audit Report - January 2025
reportType string
Report type (e.g. AUDIT)
Allowed value: AUDIT
Example: AUDIT
format string
Report file format. Provide together with fileName + fileSize when replacing the file.
Allowed values: PDF CSV
Example: PDF
fileName string
Original filename with extension. Provide together with format + fileSize when replacing the file.
Min length: >= 1 characters
Example: audit-report-jan-2025.pdf
fileSize number
New file size in bytes; rejected if > 50 * 1024 * 1024 (50 MB). Provide together with fileName + format.
Example: 1048576
reportPeriodFrom string <date-time>
Start of report period
Example: 2025-01-01T00:00:00.000Z
reportPeriodTo string <date-time>
End of report period
Example: 2025-01-31T23:59:59.999Z
description string
Optional description of the report
Example: Monthly audit report covering all mint/burn transactions

200 Response

presignedUrl string
Presigned S3 PUT URL — present only when the request replaced the underlying file.
Min length: >= 1 characters
expiresAt string <date-time>
ISO timestamp when the presigned URL stops being valid (5 min from issuance).
id string <uuid>required
Unique identifier for the report
Example: 95bdbd9c-9cdc-41a4-ae70-165387b7aa51
stablecoin string required
Stablecoin identifier
Allowed values: gousd usd1 sofid cusd fyusd goqxmp
Example: GOUSD
title string required
Display title for the report
Min length: >= 1 characters
Example: Monthly Audit Report - January 2025
reportType string required
Report type (e.g. AUDIT)
Allowed value: AUDIT
Example: AUDIT
format string required
Report file format
Allowed values: PDF CSV
Example: PDF
status string required
Report status
Allowed values: ACTIVE ARCHIVED
Example: ACTIVE
fileName string required
Original filename with extension
Min length: >= 1 characters
Example: audit-report-jan-2025.pdf
fileSize number required
File size in bytes
Example: 1048576
createdAt string <date-time>required
Timestamp when the report was created
Example: 2025-01-15T10:30:00.000Z
createdBy string required
User ID who created the report
Min length: >= 1 characters
Example: 677cfdceca8396cf5f7534ddeb8d11e3
updatedAt string <date-time>required
Timestamp when the report was last updated
Example: 2025-01-15T10:30:00.000Z
reportPeriodFrom string <date-time>
Start of report period
Example: 2025-01-01T00:00:00.000Z
reportPeriodTo string <date-time>
End of report period
Example: 2025-01-31T23:59:59.999Z
description string
Description of the report
Example: Monthly audit report covering all mint/burn transactions

400 Response

404 Response

500 Response