Confirm File Detection
Confirms the detection/validation of a file after upload. This endpoint processes
Description
detection session results and queues the file for processing. For ZIP files, provide an array of file confirmations with individual source/period assignments for each extracted file. Dual-Period Sources: Some sources (e.g., Merlin SNAP) require both a sale period and an accounting period. For these sources, provide bothsalePeriod (when sales occurred)
and accountingPeriod (when royalties are reported).
Inline Source Creator: If the file was processed through the Source Creator wizard
(launched via /file/session/{sessionId}/start-source-creator), pass the
sourceCreatorSessionId to resolve the newly created source automatically.
The royaltySource and schema fields will be populated from the Source Creator session.
Authorization:
- Required role:
adminor higher
Code Examples
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Path Parameters
Detection session ID from file upload
Body
Confirmed royalty source name (for single files)
Confirmed accounting period (for single files, or both single and dual-period sources)
Sale period for dual-period sources (when sales occurred)
Confirmed schema mapping (optional)
Additional processing parameters
Individual file confirmations for ZIP files
Optional. ID of a completed Source Creator session (status: 'saved'). When provided, the royalty source name and schema are resolved from the session's created source. Use this after the inline Source Creator wizard creates a new source for an unrecognized file.
Set to true to proceed with processing despite a major schema
disparity (e.g., columns inserted in the middle, delimiter changed).
Without this flag, the endpoint returns 409 when a major disparity
is detected, suggesting a new source version should be created.
Set to true to load the file even when its column count does not
match the source schema. Missing schema columns are filled with NULL
and unknown file columns are dropped (BigQuery ignoreUnknownValues).
Use this only after presenting the user with the structured
schema_mismatch response (status 422) so they can make an informed
choice between switching source, creating a new version, or processing
anyway.