Skip to main content
POST
Confirm File Detection
This endpoint requires authentication. Include your Bearer token in the Authorization header.

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 both salePeriod (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: admin or higher

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

sessionId
string<uuid>
required

Detection session ID from file upload

Body

application/json
royaltySource
string

Confirmed royalty source name (for single files)

accountingPeriod
string<date>

Confirmed accounting period (for single files, or both single and dual-period sources)

salePeriod
string<date>

Sale period for dual-period sources (when sales occurred)

schema
object

Confirmed schema mapping (optional)

parameters
object

Additional processing parameters

fileConfirmations
object[]

Individual file confirmations for ZIP files

sourceCreatorSessionId
string<uuid>

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.

acknowledgeSchemaDisparity
boolean
default:false

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.

acceptMismatch
boolean
default:false

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.

Response

File detection confirmed

success
boolean
default:true
message
string
data
object