How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.

15 operations 8 paths 29 schemas 2 DELETE6 GET2 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-06-28
Base URL
https://api.syntage.com
Authentication
API Key
Contact
Resource Areas
1

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.

Entities 15

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"…

GET
/entities
List all entities
ListEntity 20 params → 200401
POST
/entities
Add an Entity
AddEntity body → 201401
GET
/entities/{entityId}
Retrieve an Entity
GetEntity 1 param → 200401404
PATCH
/entities/{entityId}
Update an Entity
UpdateEntity 1 param body → 200401
DELETE
/entities/{entityId}
Delete an Entity
DeleteEntity 1 param → 204401404
POST
/entities/batch/tags
Tag multiple entities
TagEntitiesBatch body → 201401404422
POST
/entities/batch/tags/remove
Untag multiple entities
UntagEntitiesBatch body → 201401404422
GET
/entities/{entityId}/tags
List an entity's tags
ListEntityTags 4 params → 200401404
GET
/entities/{entityId}/identifiers
List an entity's identifiers
ListEntityIdentifiers 1 param → 200401404
POST
/entities/{entityId}/identifiers
Add an entity identifier
AddEntityIdentifier 1 param body → 201400401404
GET
/entity-tags
List all entity tags
ListAllEntityTags 3 params → 200401
POST
/entity-tags
Create an entity tag
CreateEntityTag body → 201401
GET
/entity-tags/{id}
Retrieve an entity tag
GetEntityTag 1 param → 200401404
PATCH
/entity-tags/{id}
Update an entity tag
UpdateEntityTag 1 param body → 200401
DELETE
/entity-tags/{id}
Delete an entity tag
DeleteEntityTag 1 param → 204401404

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.

updatedAt
string
Date and time the resource was last updated
TagEntitiesBatch
object
2 properties
EntityTagCollection
array
EntityType
string
Type of entity
CollectionOrder
string
createdAt
string
Date and time the resource was created
CursorCollection
object
6 properties
Credential
object
8 properties
Collection
EntityIdentifierCreateInput
object
3 properties 3 required
TaxpayerName
string
Taxpayer name
uuid
string
EntityTag
object
7 properties
TaxpayerID
string
RFC (Registro Federal de Contribuyentes)
HydraView
object
6 properties
EntityCollection
EntityIdentifier
object
9 properties
TagEntitiesBatchInput
object
2 properties 2 required
EntityTagUpdateInput
object
2 properties
TaxpayerPersonType
string
EntityUpdateInput
object
2 properties
CredentialStatus
string
Credential validation status: | Value | Description | | --- | --- | | waiting | Credential validation is temporarily disabled, usually because of an ongoing in…
CredentialType
string
Entity
object
9 properties
EntityTagCreateInput
object
2 properties 1 required
CollectionLimit
integer
EntityIdentifierCollection
Taxpayer
object
6 properties
DatasourceName
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

syntage-entities-api-openapi.yml Raw ↑

Other APIs Syntage publishes across the network.

Syntage Accounts Payable Insight API
Syntage Accounts Receivable Insight API
Syntage Background Checks API
Syntage Balance Sheet Insight API
Syntage Cash Flow Insight API
Syntage Company Verification Reports API
Syntage Corporate Structure Insight API
Syntage Customer Concentration Insight API
Syntage Customer Network Insight API
Syntage DS MX BIL Reports API
Syntage DS MX Buró de Crédito Authorizations API
Syntage DS MX Buró de Crédito Reports API
Where this information came from

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.