Skip to content
/api/insiders/sync

Process one supplied filing.

Process one supplied filing. When XML content is provided, the handler attempts synchronous processing; otherwise, or if that attempt fails, it queues the filing for background processing.

25 tokensSince v1.0.0

Why use this

Submit a detected filing for processing. Use data.status to distinguish a completed synchronous result from a queued background task; the latter supplies data.task_id for correlation.

Returns the standard success envelope for one filing submission. A queued result contains data.status="queued" and data.task_id. Successful processing of supplied XML returns data.status="processed" and data.filing_id. The response does not contain queued_at, estimated_seconds, or a completion estimate.

Response schema

FieldTypeNullableDescription
statusstringnoSuccess envelope status: success.
dataobjectnoResult for the requested filing: queued or processed.
data.statusstringnoqueued when background processing is scheduled; processed when supplied XML was processed synchronously.
data.task_idstringnoBackground task identifier, present only for queued results.
data.filing_idstringnoProcessed filing identifier, present only for processed results.
metaobjectnoMessage describing whether the filing was processed or queued.
meta.messagestringnoFiling processing outcome message.
errorobjectyesNull on success.
request_idstringyesRequest identifier; null when not assigned.
timestampstringnoResponse generation timestamp; the runtime can omit the timezone offset.

Sample response

·
  • "status": "success"
  • "data":
    • "status": "queued"
    • "task_id": "8f1a2b30-c4d5-46e7-9f01-23456789abcd"
    }
  • "meta":
    • "message": "Filing processing queued successfully"
    }
  • "error": null
  • "request_id": null
  • "timestamp": "2026-05-01T20:55:12"
}

Errors

StatusLabelDescription
200OKRequest succeeded.
400Bad RequestInvalid query, body, or path parameter.
401UnauthorizedMissing or invalid Authorization header / api_Token.
402Payment RequiredInsufficient token balance for this call. Top up
429Too Many RequestsRate limit exceeded for your tier (see /pricing for tier limits). Tier limits
500Server ErrorUnexpected server-side failure. Retry with backoff; report if persistent.

Code samples

curl -X POST "https://api.finradar.ai/api/insiders/sync?api_Token=YOUR_API_KEY" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Generate an API key in /account/credentials to run live queries (literal YOUR_API_KEY placeholder shown until then).

Try it

Related endpoints