Fintary AMS API documentation

entityType

entityId

List activity-feed entries for an AMS record (from the audit_logs store)

query

strId

contractId

Get agent hierarchy tree (uplines and downlines)

Get the full hierarchy tree for an agent (ancestors + descendants)

List custom field definitions for the current account

Counts of customers created and policies linked

page

pageSize

List a customer's real commission statement lines

Get filter option values for the policy list

Get policy commission info (receivables, payouts by role, statement totals)

List policy documents (Document Repository Service)

Mints a short-lived signed PUT URL from the Document Repository Service. The client uploads the bytes straight to storage, then calls the finalize endpoint. The document is stamped with `metadata.policyId`.


Start a policy document upload (phase 1 of two)

Flips the Document Repository Service document to ACTIVE once the client has uploaded the bytes to the signed URL. Until this call lands the document is not returned by the list endpoint.


Finalize a policy document upload (phase 2 of two)

Removes the document from the Document Repository Service. Metadata is immutable in DRS, so there is no update route -- name and expiry are captured at upload.


documentStrId

Returns a short-lived signed URL issued by the Document Repository Service. The document is resolved through its policy, so one belonging to another policy or account cannot be fetched.


Short-lived signed download URL for a policy document

The status is not configured for the policy entity

taskId

entity

Get the AI/wire manifest (bindable fields, widget vocabulary, endpoint allowlist, limits) for an AMS entity

Get the wire page config for an AMS entity

Make one of the calling account's saved page-config variants its active default

Save a named page-config variant for the calling account

List the calling account's saved page-config variants for an AMS entity (excludes the account's active default)

Get the current user's agent scope (self + downline contacts)

Get a summary of the current user's tasks