Syntage DS MX SAT Certificates API
The DS MX SAT Certificates API from Syntage — 2 operation(s) for ds mx sat certificates.
OpenAPI Specification
openapi: 3.0.2
info:
version: '2020-06-28'
title: Syntage Accounts Payable Insight DS MX SAT Certificates API
contact:
name: Email
email: support@syntage.com
description: "# Introduction\n\nThe Syntage API is organized around [REST](https://en.wikipedia.org/wiki/Representational_State_Transfer).\nOur API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns [JSON-LD](https://json-ld.org) responses, and uses standard HTTP response codes, authentication, and verbs.\n\n# Environments\n\n| Name | Description | Base URL |\n|------|-------------|----------|\n| **Sandbox** | The Sandbox environment is dedicated to development and testing. In this environment, no real taxpayer credentials are required and all interaction with the SAT is simulated generating life-like data, allowing you to pull test data from all endpoints. | https://api.sandbox.syntage.com |\n| **Production** | The Production environment is dedicated to live applications with real connections to the SAT. In this environment, real taxpayer credentials are required, and you will pull real fiscal data directly from the SAT. | https://api.syntage.com |\n\nEach environment has a different API Key for [authentication](#section/Authentication).\n\n# Request IDs\n\nEach API request has an associated request identifier.\nYou can find this value in the response headers, under `X-Request-ID`:\n\n```curl\ncurl -i https://api.syntage.com\nHTTP/1.1 200 OK\nDate: Sun, 29 Nov 2020 19:21:21 GMT\nX-Request-ID: Root=1-6532dcae-169bf139354cd48959f55c55\n```\n\nIf you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.\n\n# Rate Limiting\n\nOur API employs a number of safeguards against bursts of incoming traffic to help maximize its stability.\nThe returned HTTP headers of any API request show your current rate limit status:\n\n```curl\ncurl -i https://api.syntage.com\nHTTP/1.1 200 OK\nDate: Sun, 29 Nov 2020 19:21:21 GMT\nX-RateLimit-Limit: 60\nX-RateLimit-Remaining: 56\nX-RateLimit-Reset: 1606678044\n```\n\n| Header Name | Description |\n|-----------------------|------------------------------------------------------------------------------|\n| X-RateLimit-Limit | The maximum number of requests you're permitted to make. |\n| X-RateLimit-Remaining | The number of requests remaining in the current rate limit window. |\n| X-RateLimit-Reset | The time at which the current rate limit window resets in UTC epoch seconds. |\n\nIf you exceed the rate limit, a [429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) response is returned:\n\n```http\nHTTP/1.1 429 Too Many Requests\nDate: Sun, 29 Nov 2020 19:21:21 GMT\nX-RateLimit-Limit: 60\nX-RateLimit-Remaining: 0\nX-RateLimit-Reset: 1606678044\n```\n\nWe may reduce limits to prevent abuse, or increase limits to enable high-traffic operations.\nYou can check your current limits in the [dashboard](https://app.syntage.com/settings/usage).\nTo request an increased rate limit, please [contact support](https://support.syntage.com/).\n# Pagination\nWhen issuing a GET request on a collection containing more than 1 page (e.g. [/events](#operation/ListEvent)), a collection is returned. Links to the first, the last, previous and the next page in the collection are displayed as well as the number of total items in the collection.\nAll endpoints that support this operation have a query parameter defined by:\n - `itemsPerPage` The number of items per page (default: 20, max: 1000)\n - `page` The collection page number\n\n```bash\n \"hydra:totalItems\": 1,\n \"hydra:view\": {\n \"@id\": \"/events?page=1\",\n \"@type\": \"hydra:PartialCollectionView\",\n \"hydra:first\": \"/events?page=1\",\n \"hydra:next\": \"/events?page=2\",\n \"hydra:last\": \"/events?page=3\"\n },\n```\n## Cursor Pagination\nCursor pagination is a technique used for navigating through large datasets efficiently. It allows you to retrieve a specific subset of results from a collection by using a cursor value that represents the position within the collection. The cursor serves as a reference point for fetching the next or previous set of results.\n### Benefits of Cursor Pagination:\n1. **Efficient Navigation:** Cursor pagination eliminates the need to fetch the entire dataset at once, making it more scalable and faster. You can retrieve data in smaller, manageable chunks based on the cursor values.\n2. **Consistent Results:** Each page of results in cursor pagination is stable and doesn't change even if new items are added or removed from the collection. This ensures that you get consistent and reliable results.\n3. **Flexibility:** Cursors can be used to navigate forwards and backwards in the collection without impacting performance.\n\n### How to Use Cursor Pagination:\nTo use cursor pagination with our API, follow these instructions:\n1. Make a request to retrieve the initial page of results. The response will be a JSON-LD document that includes a `hydra:next` attribute with the URI for the next page. The URI already includes the cursor attribute.\n2. To retrieve the next page of results, make a GET request to the URI provided in the `hydra:next` attribute. This URI will automatically include the cursor value for the next page.\n3. If you want to navigate to the previous page, you can use the `hydra:previous` attribute in the JSON-LD response. It will contain the URI for the previous page, including the cursor value.\n4. You can continue making requests to the `hydra:next` and `hydra:previous` URIs to navigate through the paginated results, based on your requirements.\nMake sure to update your request headers to include the necessary headers for JSON-LD content negotiation, such as `Accept: application/ld+json` or `Content-Type: application/ld+json`.\nBy following these instructions, you can effectively navigate through the paginated results using the cursor values provided in the `hydra:next` and `hydra:previous` attributes, without the need to manually include the cursor in your requests. This simplifies the pagination process and enhances the usability of our API.\n\n### Considerations About Cursor Pagination:\n\n - By default, the API uses offset-based pagination (except for a few endpoints that we will list below). If you want to switch to cursor pagination, you need to include an additional header in your request. Set the `X-Pagination-Style` header with the value `\"cursor\"` to enable cursor pagination. If not specified, the API will assume offset-based pagination.\n\n - After enabling cursor pagination, the API response will no longer include the `hydra:totalItems` field by default. Retrieving the total count can be resource intensive and impact response times, especially for large datasets. However, if you need the `hydra:totalItems` information, you can include an additional header in your request. Set the `X-Pagination-Enable-Partial` header with the value `0` to indicate that the response should include extra information, including the `hydra:totalItems` count. Please be aware that enabling this feature may impact API response times, as the backend needs to perform a count operation on the dataset.\n\nIf you require the `hydra:totalItems` count, please consider the potential impact on API response times.\n### Example\n```bash\n curl -i 'https://api.syntage.com/entities/{entityId}/invoices?itemsPerPage=10' \\\n --header 'Accept: application/ld+json' \\\n --header 'X-Api-Key: {apiKey}' \\\n --header 'X-Pagination-Style: cursor' \\\n --header 'X-Pagination-Enable-Partial: 0'\n```\n**Note:** We only support cursor pagination for the following endpoints:\n - `GET /entities/{entityId}/invoices`\n - `GET /entities/{entityId}/invoices/line-items`\n - `GET /entities/{entityId}/invoices/{invoiceId}/line-items`\n - `GET /invoices/{invoiceId}/line-items`\n - `GET /entities/{entityId}/invoices/payments`\n\nFeel free to reach out if you have any further questions or need additional assistance!\n\n# Property Filtering\nThe property filter adds the possibility to select the properties for GET operations.\nSyntax: `?properties[]=<property>&properties[<relation>][]=<property>`\nYou can add as many properties as you need. The following example shows how to select `paymentType` and `issuer.rfc` when fetching a list of invoices.\n```curl\n curl -i https://api.syntage.com/entities/{entityId}/invoices?properties[]=paymentType&properties[issuer]=rfc\n```\n# Filtering\n**Warning:** Collection endpoints only apply the filter query parameters documented for that endpoint. If you send an unsupported or misspelled filter query parameter, the API ignores it and processes the request as if that parameter was not sent.\n\n# API Versioning Guide\nGuidance on changes between versions.\n## Version: 2020-01-01 to 2020-06-28\n### **Invoice**\n_**Affected Endpoints:** `GET /invoices/{id}` and `GET /entities/{entityId}/invoices`_\n- The `amount` property has been removed from API responses. Use the `total` property instead.\n- Retrieval by invoice's `uuid` at `/invoices/{id}` is now removed. To retrieve an invoice, use the invoice's `id` at the specified endpoint. To find an invoice using its `uuid`, filter the invoice collection at `/entities/{entityId}/invoices?uuid[]={uuid}`.\n- Previously, the `@iri` property for an invoice pointed to the resource using `uuid`, like `/invoices/{uuid}`. Now, it points using its `id`, like `/invoices/{id}`.\n\n### **Entity (Formerly Link)**\n_**Affected Endpoint:** `GET /entities`_\n- Filtering entities by `status` is removed. Use `credential.status` instead. For example, utilize `GET /entities?credential.status[]=active` instead of `GET /entities?status[]=active`.\n\n### **Tax Return**\n_**Affected Endpoints:** `GET /tax-returns/{id}` and `GET /entities/{entityId}/tax-returns`_\n- Retrieval by tax return's `operationNumber` at `/tax-returns/{id}` is removed. To retrieve a tax return, use the tax return's `id` at the mentioned endpoint. To find a tax return using its `operationNumber`, filter the collection at `/entities/{entityId}/tax-returns?operationNumber[]={operationNumber}`.\n- Previously, the `@iri` property for a tax return pointed to the resource using `operationNumber`, like `/tax-returns/{operationNumber}`. Now, it directs to its `id`, like `/tax-returns/{id}`.\n\n### **Event**\n_**Affected Endpoints:** `GET /events` and `GET /events/{id}`_\n- For events associated to an `tax-return`, the `@iri` property now directs to `/tax-returns/{id}` instead of the previous `/tax-returns/{operationNumber}`.\n- For events associated to an `invoice`, the `@iri` property now directs to `/invoices/{id}` instead of the previous `/invoices/{uuid}`.\n\n### **Extraction**\n_**Affected Endpoints:** `GET /extractions` and `GET /extractions/{id}`_\n- The `periodFrom` property has been removed. Use `options.period.from` instead.\n- The `periodTo` property has been removed. Use `options.period.to` instead.\n\n### **File**\n_**Affected Endpoint:** `GET /file/{id}`_\n- For files associated to an `tax-return`, the `@iri` property now directs to `/tax-returns/{id}`, instead of the previous `/tax-returns/{operationNumber}`.\n- For files associated to an `invoice`, the `@iri` property now directs to `/invoices/{id}`, instead of the previous `/invoices/{uuid}`.\n\n### Trying Out This Version\nIf you want to test this version, you can do so by making any request with the `Accept-Version` header pointing to the latest version:\n```curl\n curl -i 'https://api.syntage.com/entities/{entityId}/invoices' \\\n --header 'Accept-Version: 2020-06-28' \\\n --header 'X-Api-Key: {apiKey}'\n```\n"
servers:
- url: https://api.syntage.com
description: Production
- url: https://api.sandbox.syntage.com
description: Sandbox
security:
- ApiKey: []
tags:
- name: DS MX SAT Certificates
paths:
/entities/{entityId}/datasources/mx/sat/certificados:
get:
tags:
- DS MX SAT Certificates
operationId: GetEntityMxSatCertificates
summary: List an entity's SAT certificates
description: 'List SAT certificates associated with an entity.
These digital certificates are used for electronic signatures and digital sealing in Mexico''s tax system.
'
parameters:
- $ref: '#/components/parameters/entityId'
- $ref: '#/components/parameters/collectionCursorNextPageParam'
- $ref: '#/components/parameters/collectionCursorPreviousPageParam'
- $ref: '#/components/parameters/collectionLimit'
- $ref: '#/components/parameters/validFromBefore'
- $ref: '#/components/parameters/validFromStrictlyBefore'
- $ref: '#/components/parameters/validFromAfter'
- $ref: '#/components/parameters/validFromStrictlyAfter'
- $ref: '#/components/parameters/validToBefore'
- $ref: '#/components/parameters/validToStrictlyBefore'
- $ref: '#/components/parameters/validToAfter'
- $ref: '#/components/parameters/validToStrictlyAfter'
- $ref: '#/components/parameters/orderValidFrom'
- $ref: '#/components/parameters/orderValidTo'
- $ref: '#/components/parameters/serialNumberFilter'
- $ref: '#/components/parameters/certificateTypeFilter'
responses:
'200':
description: SAT Certificates
content:
application/ld+json:
schema:
type: object
allOf:
- $ref: '#/components/schemas/Collection'
- type: object
properties:
'@context':
default: /contexts/SatCertificate
'@id':
example: /entities/91ab5678-1234-5678-9abc-def012345678/datasources/mx/sat/certificados
hydra:member:
type: array
items:
$ref: '#/components/schemas/SatCertificate'
hydra:search:
type: object
properties:
'@type':
type: string
default: hydra:IriTemplate
hydra:template:
example: /entities/91ab5678-1234-5678-9abc-def012345678/datasources/mx/sat/certificados{?validFrom[before],validFrom[strictly_before],validFrom[after],validFrom[strictly_after],validTo[before],validTo[strictly_before],validTo[after],validTo[strictly_after],order[validFrom],order[validTo],serialNumber,type}
hydra:variableRepresentation:
type: string
default: BasicRepresentation
hydra:mapping:
type: array
items:
type: object
properties:
'@type':
type: string
default: IriTemplateMapping
variable:
type: string
property:
type: string
required:
type: boolean
default: false
example:
- '@type': IriTemplateMapping
variable: validFrom[before]
property: validFrom
required: false
- '@type': IriTemplateMapping
variable: validFrom[strictly_before]
property: validFrom
required: false
- '@type': IriTemplateMapping
variable: validFrom[after]
property: validFrom
required: false
- '@type': IriTemplateMapping
variable: validFrom[strictly_after]
property: validFrom
required: false
- '@type': IriTemplateMapping
variable: validTo[before]
property: validTo
required: false
- '@type': IriTemplateMapping
variable: validTo[strictly_before]
property: validTo
required: false
- '@type': IriTemplateMapping
variable: validTo[after]
property: validTo
required: false
- '@type': IriTemplateMapping
variable: validTo[strictly_after]
property: validTo
required: false
- '@type': IriTemplateMapping
variable: order[validFrom]
property: validFrom
required: false
- '@type': IriTemplateMapping
variable: order[validTo]
property: validTo
required: false
- '@type': IriTemplateMapping
variable: serialNumber
property: serialNumber
required: false
- '@type': IriTemplateMapping
variable: type
property: type
required: false
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
/datasources/mx/sat/certificados/{id}:
get:
tags:
- DS MX SAT Certificates
operationId: GetMxSatCertificate
summary: Retrieve a SAT certificate
description: 'Retrieve a SAT certificate by ID.
The `file` property references the certificate file. Use the file download endpoint to retrieve the certificate content.
'
parameters:
- $ref: '#/components/parameters/resourceId'
responses:
'200':
description: SAT Certificate
content:
application/ld+json:
schema:
type: object
allOf:
- type: object
properties:
'@context':
default: /contexts/SatCertificate
'@id':
example: /datasources/mx/sat/certificados/0197a365-6c09-7019-b072-6c756008cd2d
- $ref: '#/components/schemas/SatCertificate'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
components:
schemas:
TaxpayerID:
type: string
minLength: 12
maxLength: 13
description: RFC (Registro Federal de Contribuyentes)
example: PEIC211118IS0
Collection:
allOf:
- $ref: '#/components/schemas/HydraView'
- type: object
properties:
hydra:search:
type: object
properties:
'@type':
type: string
hydra:template:
type: string
hydra:variableRepresentation:
type: string
hydra:mapping:
type: array
items:
type: object
properties:
'@type':
type: string
variable:
type: string
property:
type: string
required:
type: boolean
updatedAt:
type: string
description: Date and time the resource was last updated
example: '2020-01-01T12:15:00.000Z'
CollectionLimit:
type: integer
default: 20
minimum: 1
maximum: 1000
createdAt:
type: string
description: Date and time the resource was created
example: '2020-01-01T12:15:00.000Z'
File:
type: object
properties:
'@id':
type: string
format: iri-reference
description: File IRI reference
example: /files/91106968-1abd-4d64-85c1-4e73d96fb997
'@type':
type: string
description: JSON-LD resource type
default: File
example: File
id:
type: string
format: uuid
description: Unique file ID
example: 91106968-1abd-4d64-85c1-4e73d96fb997
type:
type: string
description: File category, such as an invoice CFDI XML or PDF
example: invoice.cfdi.xml
resource:
type: string
description: IRI of the resource that produced or owns the file
example: /invoices/7c45e9c6-8f7f-4d0e-b6e5-65fef6c8c2f9
mimeType:
type: string
description: Media type of the file content
example: text/xml
extension:
type: string
description: File extension for the stored content
example: xml
size:
type: integer
description: File size in bytes
example: 40544
filename:
type: string
description: Suggested filename for the file content
example: 6f3c5312-2849-4525-86f6-c48a54c64c60.xml
createdAt:
$ref: '#/components/schemas/createdAt'
updatedAt:
$ref: '#/components/schemas/updatedAt'
CollectionOrder:
type: string
enum:
- asc
- desc
example: asc
HydraView:
type: object
properties:
'@context':
type: string
'@id':
type: string
'@type':
type: string
default: hydra:Collection
hydra:member:
type: array
items:
type: object
hydra:totalItems:
type: integer
description: Total number of items found
minimum: 0
example: 1
hydra:view:
type: object
description: Pagination information
properties:
'@id':
type: string
format: iri-reference
description: Current page IRI reference
'@type':
type: string
default: hydra:PartialCollectionView
hydra:first:
type: string
format: iri-reference
description: First page IRI reference; omitted when there is no pagination
hydra:next:
type: string
format: iri-reference
description: Next page IRI reference; omitted when there is no pagination
hydra:last:
type: string
format: iri-reference
description: Last page IRI reference; omitted when there is no pagination
SatCertificate:
type: object
required:
- id
- link
- serialNumber
- type
- issuer
- subject
- validFrom
- validTo
- file
- status
- revokedAt
- createdAt
- updatedAt
properties:
'@id':
type: string
format: iri-reference
description: SAT Certificate IRI reference
example: /datasources/mx/sat/certificados/0197a365-6c09-7019-b072-6c756008cd2d
'@type':
type: string
default: SatCertificate
id:
type: string
format: uuid
description: SAT certificate ID
example: 0197a365-6c09-7019-b072-6c756008cd2d
link:
type: string
format: iri-reference
description: Entity IRI reference
example: /entities/91ab5678-1234-5678-9abc-def012345678
serialNumber:
type: string
description: Certificate serial number
example: 00001000000516152485
type:
type: string
enum:
- efirma
- csd
description: Certificate type
example: efirma
issuer:
type: object
description: Certificate issuer information
properties:
id-at-commonName:
type: string
example: AUTORIDAD CERTIFICADORA
id-at-postalCode:
type: string
example: '06300'
id-at-countryName:
type: string
example: MX
id-at-localityName:
type: string
example: CUAUHTEMOC
id-at-streetAddress:
type: string
example: AV. HIDALGO 77, COL. GUERRERO
id-at-organizationName:
type: string
example: SERVICIO DE ADMINISTRACION TRIBUTARIA
id-at-uniqueIdentifier:
type: string
example: SAT970701NN3
pkcs-9-at-emailAddress:
type: string
example: contacto.tecnico@sat.gob.mx
id-at-stateOrProvinceName:
type: string
example: CIUDAD DE MEXICO
pkcs-9-at-unstructuredName:
type: string
example: 'responsable: ADMINISTRACION CENTRAL DE SERVICIOS TRIBUTARIOS AL CONTRIBUYENTE'
id-at-organizationalUnitName:
type: string
example: SAT-IES Authority
subject:
type: object
description: Certificate subject information
properties:
id-at-name:
type: string
example: JUAN MANUEL PEREZ GONZALEZ
id-at-commonName:
type: string
example: JUAN MANUEL PEREZ GONZALEZ
id-at-countryName:
type: string
example: MX
id-at-serialNumber:
$ref: '#/components/schemas/TaxpayerID'
id-at-organizationName:
type: string
example: JUAN MANUEL PEREZ GONZALEZ
id-at-uniqueIdentifier:
type: string
example: PEGJ850101AA1
pkcs-9-at-emailAddress:
type: string
example: juan.perez@example.com
validFrom:
type: string
format: date-time
description: Certificate validity start date
example: '2022-11-11 19:02:09'
validTo:
type: string
format: date-time
description: Certificate validity end date
example: '2026-11-11 19:02:49'
file:
allOf:
- $ref: '#/components/schemas/File'
- type: object
description: Certificate file. Use the file download endpoint to retrieve the actual file content.
example:
type: sat.certificate.efirma
resource: /datasources/mx/sat/certificados/0197a365-6c09-7019-b072-6c756008cd2d
mimeType: application/x-x509-ca-cert
extension: cer
filename: 91ab5678-1234-5678-9abc-def012345678-00001000000516152485.cer
status:
type: string
enum:
- valid
- revoked
- expired
description: Certificate status
nullable: true
example: valid
revokedAt:
type: string
format: date-time
description: Date and time when the certificate was revoked, if applicable
nullable: true
example: '2023-01-01T12:00:00Z'
createdAt:
$ref: '#/components/schemas/createdAt'
updatedAt:
$ref: '#/components/schemas/updatedAt'
parameters:
collectionCursorNextPageParam:
name: id[lt]
in: query
required: false
example: 91106968-1abd-4d64-85c1-4e73d96fb997
description: Collection cursor pointer to the next page
schema:
type: string
validToBefore:
name: validTo[before]
in: query
description: Filter certificates by validity end date (less than or equal `<=`)
example: '2030-01-01T00:00:00+00:00'
schema:
type: string
format: date-time
validToStrictlyAfter:
name: validTo[strictly_after]
in: query
description: Filter certificates by validity end date (greater than `>`)
example: '2025-01-01T00:00:00+00:00'
schema:
type: string
format: date-time
orderValidTo:
name: order[validTo]
in: query
description: Order certificates by validity end date
schema:
$ref: '#/components/schemas/CollectionOrder'
orderValidFrom:
name: order[validFrom]
in: query
description: Order certificates by validity start date
schema:
$ref: '#/components/schemas/CollectionOrder'
validFromStrictlyBefore:
name: validFrom[strictly_before]
in: query
description: Filter certificates by validity start date (less than `<`)
example: '2025-01-01T00:00:00+00:00'
schema:
type: string
format: date-time
validToAfter:
name: validTo[after]
in: query
description: Filter certificates by validity end date (greater than or equal `>=`)
example: '2025-01-01T00:00:00+00:00'
schema:
type: string
format: date-time
validToStrictlyBefore:
name: validTo[strictly_before]
in: query
description: Filter certificates by validity end date (less than `<`)
example: '2030-01-01T00:00:00+00:00'
schema:
type: string
format: date-time
validFromBefore:
name: validFrom[before]
in: query
description: Filter certificates by validity start date (less than or equal `<=`)
example: '2025-01-01T00:00:00+00:00'
schema:
type: string
format: date-time
validFromAfter:
name: validFrom[after]
in: query
description: Filter certificates by validity start date (greater than or equal `>=`)
example: '2020-01-01T00:00:00+00:00'
schema:
type: string
format: date-time
collectionLimit:
name: itemsPerPage
in: query
required: false
description: Number of items per page
schema:
$ref: '#/components/schemas/CollectionLimit'
certificateTypeFilter:
name: type
in: query
description: Filter certificates by type
schema:
type: string
enum:
- efirma
- csd
validFromStrictlyAfter:
name: validFrom[strictly_after]
in: query
description: Filter certificates by validity start date (greater than `>`)
example: '2020-01-01T00:00:00+00:00'
schema:
type: string
format: date-time
collectionCursorPreviousPageParam:
name: id[gt]
in: query
required: false
example: 91106968-1abd-4d64-85c1-4e73d96fb997
description: Collection cursor pointer to the previous page
schema:
type: string
serialNumberFilter:
name: serialNumber
in: query
description: Filter certificates by serial number (supports partial matching)
example: 00001000000516152485
schema:
type: string
resourceId:
name: id
in: path
required: true
example: 91106968-1abd-4d64-85c1-4e73d96fb997
schema:
type: string
format: uuid
entityId:
name: entityId
in: path
required: true
example: 91106968-1abd-4d64-85c1-4e73d96fb997
schema:
type: string
format: uuid
responses:
NotFound:
description: Not found
content:
application/json:
schema:
type: object
properties:
message:
type: string
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
message:
type: string
securitySchemes:
ApiKey:
type: apiKey
in: header
name: X-API-Key
description: '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) dashboards.
'
x-readme:
explor
# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/syntage/refs/heads/main/openapi/syntage-ds-mx-sat-certificates-api-openapi.yml