Syntage Events API
Events record meaningful changes to resources in your organization.When something changes, Syntage creates an Event resource. For example, submitting an entity's SAT credential can create credential and entity events, and a completed extraction can create an `extraction.updated` event.Many requests can create more than one event. For example, submitting valid SAT credentials for an entity can create `credential.created`, `credential.updated`, and `link.created` events.Events occur when the state of another resource changes. The state of that resource at the time of the change is embedded in the event's `data` field. For example, a `credential.updated` event contains a Credential, and an `invoice.updated` event contains an Invoice.Use the Events endpoints to retrieve recent events directly. Use [webhooks](/api-reference/webhooks/overview) when you want Syntage to deliver events to your server automatically.Access to events is only guaranteed for 7 days.Entity lifecycle events still use the `link.*` event type names for backwards compatibility.The suffix describes the kind of change:| Suffix | Meaning || --- | --- || `.created` | A new resource was created. || `.updated` | An existing resource changed. || `.deleted` | A resource was deleted or is no longer available. || Resource | Event types || --- | --- || Credentials | `credential.created`, `credential.updated`, `credential.deleted` || Entities | `link.created`, `link.updated`, `link.deleted` || Files | `file.created` || Extractions | `extraction.created`, `extraction.updated` || Exports | `export.created`, `export.updated` || Invoices | `invoice.created`, `invoice.updated`, `invoice.deleted` || Invoice payments | `invoice_payment.created`, `invoice_payment.updated` || Invoice line items | `invoice_line_item.created`, `invoice_line_item.updated` || Tax returns | `tax_return.created`, `tax_return.updated`, `tax_return.deleted` || Tax status | `tax_status.created`, `tax_status.updated`, `tax_status.deleted` || Tax compliance checks | `tax_compliance_check.created`, `tax_compliance_check.updated`, `tax_compliance_check.deleted` || Tax retentions | `tax_retention.created`, `tax_retention.updated`, `tax_retention.deleted` || Electronic accounting records | `electronic_accounting_record.created`, `electronic_accounting_record.updated` || RPC entidades | `rpc_entidades.created`, `rpc_entidades.updated` || RPC socios | `rpc_socios.created`, `rpc_socios.updated` || RPC actos | `rpc_acto.created`, `rpc_acto.updated` || Shareholder relations | `shareholder_relation.created`, `shareholder_relation.updated` || Shareholder relation sources | `shareholder_relation_source.created` || RUG garantias | `rug_garantia.created`, `rug_garantia.updated` || Buró de Crédito reports | `buro_de_credito_report.created`, `buro_de_credito_report.updated` || Background checks | `background_check.created` || SAT certificates | `sat_certificate.created`, `sat_certificate.updated` || Company verification reports | `company_verification_report.created`, `company_verification_report.updated` |
Syntage Events API is one of 65 APIs that Syntage publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Event. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.
This API exposes 4 operations across 3 paths, and defines 15 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 Events 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 4
Across 3 paths, the API surfaces 4 operations — 1 DELETE, 3 GET. Each is listed below with its method, path, parameters, and response codes.
Events record meaningful changes to resources in your organization. When something changes, Syntage creates an Event resource. For example, submitting an entity's SAT credential c…
Schemas 15
The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Event (10 properties), Taxpayer (6 properties), CursorCollection (6 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 Events 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.