Skip to main content
This documentation update expands the API reference and guides for entity-based integrations, core resources, and BIL reports. Existing RFC-based endpoints remain available where they were already supported. New API features are documented with entity-based URLs and require entity IDs.

BIL reports

Affected endpoints: GET /entities/{entityId}/datasources/bil/reports, GET /datasources/bil/reports/{id}
  • The API reference now includes the endpoint for listing BIL reports generated for an entity.
  • The API reference now includes the endpoint for retrieving a single BIL report by report ID.
  • BIL report documentation now describes the main response fields, including the report folio, searched name, maximum grade, parsed vendor response, XML file, and PDF file.

Entities, identifiers, tags, and events

Affected endpoints: GET /entities, POST /entities, GET /entities/{entityId}, PATCH /entities/{entityId}, DELETE /entities/{entityId}, GET /entities/{entityId}/events, GET /entities/{entityId}/identifiers, POST /entities/{entityId}/identifiers, GET /entities/{entityId}/tags, POST /entity-tags, GET /entity-tags/{id}, PATCH /entity-tags/{id}, DELETE /entity-tags/{id}, GET /tags, POST /tags, PATCH /tags/{id}, DELETE /tags/{id}
  • The API reference now includes entity overview and endpoint pages that explain how entities are created, retrieved, updated, deleted, and used as the parent resource for datasource records.
  • Entity identifier documentation now explains how RFC and CURP identifiers can be supplied when creating an entity or added later.
  • Entity tag and tag documentation now explain how tags can be used for segmentation, extraction scheduler targeting, monitoring, and filtering entities in your own product.
  • Entity event documentation now explains how to retrieve events for a specific entity in addition to using webhook delivery.

Files and exports

Affected endpoints: GET /files/{id}, GET /files/{id}/download, POST /exports, GET /exports/{id}
  • File documentation now explains file metadata, file types, filenames, MIME types, and when to use the download endpoint for file content.
  • Export documentation now explains the asynchronous export workflow from creation through terminal statuses.
  • Export documentation now shows that completed exports return a file reference that can be downloaded through the file download endpoint.

Extractions, schedulers, and scheduler rules

Affected endpoints: GET /extractions, GET /extractions/{id}, POST /extractions/{id}/stop, GET /schedulers, POST /schedulers, GET /schedulers/{id}, PATCH /schedulers/{id}, DELETE /schedulers/{id}, POST /schedulers/rules, GET /schedulers/rules/{id}, PATCH /schedulers/rules/{id}, DELETE /schedulers/rules/{id}
  • Extraction documentation now covers the extraction lifecycle, statuses, retry behavior, duplicate extraction behavior, and datasource-specific extractor descriptions.
  • BIL is now included in the documented extractor list.
  • Scheduler and scheduler rule documentation now explains recurring extraction behavior in more detail.

Guides

Affected area: Guides navigation and conceptual documentation
  • The guides now include entity-based URL guidance that explains entity IDs and legacy RFC-based URL compatibility.
  • The environments guide now describes Sandbox and Production behavior across Syntage datasources.
  • Request ID and rate limiting guides now include response header examples and troubleshooting use cases.
  • Property filtering guidance now includes syntax examples for selecting fields from resources and related objects.
  • SAT catalog documentation now includes the catalog areas covered by the API and examples of common CFDI catalog values.
  • Webhook validation guidance now includes PHP, JavaScript/TypeScript, and Python examples for verifying request signatures.
  • Updated the integration flow guide to explain credential validation, extraction creation, extraction status tracking, webhook delivery, and file retrieval as a connected workflow.
  • Clarified that embedded entity onboarding is for integrations that need the onboarding experience inside their own site instead of redirecting to Syntage.
  • Kept deprecated widget documentation available for existing widget users while pointing new integrations to embedded entity onboarding.
  • Updated introductory documentation to describe Syntage’s API across SAT, RUG, RPC, BIL, Buro de Credito, Buro Empresas, Infonavit, and more.