Customer-facing REST API over Fintary's commission and distribution data — list, create and update agents; assign and remove uplines; read an agent's commissions, payouts, policies and dashboard snapshot; query published analytics reports, datasets and dashboard widgets; pull commission report data; and upload or convert documents. Authenticated with an `x-api-key` header API key or an HTTP bearer token. Twenty-one operations under the `/openapi/` path prefix on api.fintary.com.
This API exposes
21 operations
across 18 paths,
organized into 4 resource areas,
and defines 39 schemas.
It is described by OpenAPI 3.0.0, at version 1.0.
Requests are made against the base URL https://api.fintary.com.
21 operations18 paths39 schemas1 DELETE14 GET1 PATCH5 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://api.fintary.com
Authentication
HTTP Bearer, API Key
Resource Areas
4
Authentication & Security 2
Fintary Open API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (string) (BearerAuth).
An API key is passed in the header as x-api-key (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth — API key for authentication
Paths & Operations 21
Across 18 paths, the API surfaces 21 operations — 1 DELETE, 14 GET, 1 PATCH, 5 POST. They span 4 resource areas: Agents, Analytics, Commission Reports, Documents. Each is listed below with its method, path, parameters, and response codes.
Agents 10
GET
/openapi/agents/{id}
Get agent by ID
agents.get1 param→ 200401404
PATCH
/openapi/agents/{id}
Update an agent
agents.update1 parambody→ 200400401404
POST
/openapi/agents/{id}/assign-upline
Assign upline to an agent
agents.assignUpline1 parambody→ 200400401404
DELETE
/openapi/agents/{id}/assign-upline
Remove upline from an agent (by contacthierarchy strid)
The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are OpenAgentDetailSchema (22 properties), FlattenedPublishedReportSchema (21 properties), OpenAnalyticsWidget (19 properties), OpenAgentCreateSchema (14 properties). Each schema is shown below with its type and property counts.
AgGridCompositeDateFilterSchema
object
3 properties3 required
AgGridCompositeTextFilterSchema
object
3 properties3 required
AgGridDateFilterSchema
object
4 properties2 required
AgGridFilterModelSchema
object
AgGridNumberFilterSchema
object
4 properties3 required
AgGridTextFilterSchema
object
3 properties3 required
AnalyticsDatasetDataResponse
object
Paginated dataset rows returned by the deprecated dataset-by-name query endpoint
8 properties5 required
AnalyticsDatasetListResponse
array
List of available analytics tables
AnalyticsDatasetTable
object
5 properties1 required
AnalyticsReportColumnMetadataSchema
object
3 properties2 required
AnalyticsReportFilterSchema
object
3 properties2 required
AnalyticsReportMeasureSchema
object
3 properties3 required
AnalyticsReportsListQuerySchema
object
Query parameters for listing published analytics reports
2 properties
AnalyticsReportsListResponseSchema
array
Published analytics reports visible to the authenticated principal
AssignUplineRequestSchema
object
Request body for assigning upline to an agent
4 properties1 required
AssignUplineResponseSchema
object
Response when upline is successfully assigned
2 properties2 required
ConvertHtmlToPdfRenderingOptions
object
Optional PDF rendering options passed to the conversion service
11 properties
ConvertHtmlToPdfRequest
object
Multipart request to convert an HTML document (plus optional assets) to a PDF. Max 32 MB total.
3 properties1 required
DocumentUploadCompanyValidationSchema
DocumentUploadResponseSchema
object
3 properties3 required
DocumentUploadSchema
object
A document uploaded to the server. At least one of companyid or companyname must be provided. If neither is supplied and the system cannot determine the compan…
12 properties2 required
FlattenedPublishedReportSchema
object
Published analytics report metadata flattened per access record, including resolved dataset columns
21 properties8 required
OpenAgentCreateSchema
object
Input for creating a new agent
14 properties
OpenAgentDatasetPage
object
Paginated dataset rows returned by the agent commissions, payouts, policies, and dashboard endpoints. Wrapped in the standard Open API response envelope under…
6 properties3 required
OpenAgentDetailSchema
object
Agent detail
22 properties22 required
OpenAgentIdParamSchema
object
Path param for agent identifier. Supports strid, agentcode, or syncid.
1 property1 required
OpenAgentListQuerySchema
object
Query params for listing agents
5 properties
OpenAgentListResponseSchema
object
Paginated list of agents with total count
2 properties2 required
OpenAgentUpdateSchema
object
Input for updating an existing agent
13 properties
OpenAnalyticsWidgetListResponse
array
Analytics dashboard widgets visible to the authenticated user
OpenAnalyticsWidget
object
Resolved analytics dashboard widget with rendered chart data
19 properties19 required
OpenApiCodedErrorResponseSchema
object
Error payload that includes a machine-readable code (e.g. forbidden widget context)
2 properties2 required
OpenApiSimpleErrorResponseSchema
object
Simple error payload returned by some Open API routes
1 property1 required
RemoveUplineRequestSchema
object
Request body for removing upline (by contacthierarchy strid)
1 property1 required
RestoreDefaultWidgetRequest
object
Request body for restoring a default analytics widget
1 property1 required
OpenAPIResponseSchema
object
4 properties3 required
OpenAnalyticsWidgetTableConfig
object
Configuration for table chart-type widgets
3 properties1 required
OpenAnalyticsWidgetTableFilter
object
A single filter applied to a table widget
3 properties3 required
OpenAnalyticsWidgetGridPosition
object
Dashboard grid placement of a widget
4 properties4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Fintary Open API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
