Skip to content

Submission & Translation

Opening governed submissions and resolving them into canonical objects.

The translation API turns raw input into canonical control objects — the governed representation the platform runs on. Available today.

Open A Submission

Operation Purpose
createUploadedArtifact Stage a raw artifact (FpML / CDM / pack)
createSubmission Open a governed submission
createSubmissionFromArtifacts Open a submission directly from staged artifacts
getSubmission Inspect submission state
getSubmissionArtifacts List a submission's artifacts

Understand The Translation

Operation Returns
getTranslationReport How input was interpreted
getTranslationIssues Issues found during translation
getCanonicalPack The resolved canonical control objects
listCanonicalTrades Enumerate resolved canonical trades

Compliance Context

Operation Returns
listCompliancePacks Applicable compliance packs
listComplianceValidators Validators in force

Why Canonical Objects Matter

Running analytics against canonical objects — rather than raw client formats — is what makes results reproducible and comparable across runs. Your raw input and the platform's interpretation are both inspectable, so a translation is never a black box.

What This Means For Integration

  • Always reconcile getCanonicalPack against what you submitted before trusting a downstream run.
  • Treat getTranslationIssues as a gate: resolve issues here, not after a run.
  • Canonical trades are the unit the rest of the API reasons about.