Skip to main content
POST
curl
Finalize a report. This is the point of no return, a finalized report cannot be edited or deleted, only downloaded.

Authorizations

x-api-key
string
header
required

Path Parameters

organization_id
string<uuid>
required

Organization UUID.

application_id
string<uuid>
required

Application UUID.

report_uuid
string<uuid>
required

Report UUID.

Example:

"5ec00000-0000-4000-8000-000000000007"

Response

Report finalized; xml_s3_key and pdf_s3_key are set.

uuid
string<uuid>
case_uuid
string<uuid>
case_number
string | null
report_type
enum<string>
Available options:
SAR,
STR,
CTR,
TTR,
UTR,
IFT,
CBR,
TFR
report_type_display
string
report_code
string

goAML report code derived from report_type, e.g. STR, CTR, BCR.

report_number
string | null
status
enum<string>
Available options:
DRAFT,
VALIDATED,
FINALIZED
status_display
string
jurisdiction
string
Required string length: 2
rentity_id
string | null

Reporting entity ID issued by the FIU.

rentity_branch
string | null
submission_code
enum<string>
Available options:
E,
M
entity_reference
string | null
fiu_ref_number
string | null
currency_code_local
string | null
Required string length: 3
submission_date
string<date-time> | null
reporting_person
object
location
object
reason
string | null
action
string | null
activity
string | null
narrative
object

Five Ws narrative sections.

report_indicators
string[]
included_fields
string[]
transactions
string<uuid>[]
validation_errors
object[]

Result of the most recent validation; each entry is a {field, message} object.

validated_at
string<date-time> | null
finalized_at
string<date-time> | null
created_by_email
string | null
created_by_name
string | null
created_at
string<date-time>
updated_at
string<date-time>