Syntage Entities API
An Entity is a resource that represents a person or company. Entities can be added via Add Entity, or automatically when a credential is validated (when the status becomes "valid"). This resource controls your access to data and allows you to create new extractions. When an Entity is deleted, all data related to the entity is deleted as well.
Syntage Entities API is one of 65 APIs that Syntage publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Entities. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.
This API exposes 15 operations across 8 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 2020-06-28.
Requests are made against 2 base URLs: https://api.syntage.com, https://api.sandbox.syntage.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Syntage Entities API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-API-Key (ApiKey).
By default, every request must be authenticated.
ApiKey— Your API key is available in the [Production](https://app.syntage.com/settings/api-keys) and [Sandbox](https://app.sandbox.syntage.com/settings/api-keys) dashb…
Paths & Operations 15
Across 8 paths, the API surfaces 15 operations — 2 DELETE, 6 GET, 2 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.
An Entity is a resource that represents a person or company. Entities can be added via Add Entity, or automatically when a credential is validated (when the status becomes "valid"…
Schemas 29
The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are Entity (9 properties), EntityIdentifier (9 properties), Credential (8 properties), EntityTag (7 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Syntage 12
Other APIs Syntage publishes across the network.
This is an independent, third-party profile of Syntage Entities 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.