Syntage Company Verification Reports API

openapi: 3.2.0
info:
  version: '2020-06-28'
  title: Syntage Accounts Payable Insight Company Verification Reports 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: Company Verification Reports
  description: 'Company Verification Reports provide verification of company details and supporting files extracted from trusted sources. Use these endpoints to retrieve reports for a specific entity, list all reports, or download the generated PDF report.

    '
paths:
  /datasources/mx/company-verification/reports:
    get:
      tags:
      - Company Verification Reports
      operationId: GetCompanyVerificationReports
      summary: List company verification reports
      description: 'Lists company verification reports available to the organization. Use this endpoint when you need to page through reports across entities.

        '
      parameters:
      - $ref: '#/components/parameters/collectionCursorNextPageParam'
      - $ref: '#/components/parameters/collectionCursorPreviousPageParam'
      - $ref: '#/components/parameters/collectionLimit'
      - $ref: '#/components/parameters/orderCreatedAt'
      - $ref: '#/components/parameters/orderUpdatedAt'
      responses:
        '200':
          description: Company Verification Reports
          content:
            application/ld+json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Collection'
                - type: object
                  properties:
                    '@context':
                      default: /contexts/CompanyVerificationReport
                    '@id':
                      example: /datasources/mx/company-verification/reports
                    hydra:member:
                      type: array
                      items:
                        $ref: '#/components/schemas/CompanyVerificationReport'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /datasources/mx/company-verification/reports/{id}:
    get:
      tags:
      - Company Verification Reports
      operationId: GetCompanyVerificationReport
      summary: Retrieve a company verification report
      description: 'Retrieves one company verification report, including its verification details, metadata, and supporting file references.

        '
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Company Verification Report
          content:
            application/ld+json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    '@context':
                      default: /contexts/CompanyVerificationReport
                    '@id':
                      example: /company-verification/reports/91ab5678-1234-5678-9abc-def012345678
                - $ref: '#/components/schemas/CompanyVerificationReport'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /datasources/mx/company-verification/reports/{id}/pdf:
    get:
      tags:
      - Company Verification Reports
      operationId: GetCompanyVerificationReportPdf
      summary: Download company verification report PDF
      description: 'Downloads the generated PDF for a company verification report. The response body is the PDF file itself.

        '
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Company Verification Report PDF
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /entities/{entityId}/datasources/mx/company-verification/reports:
    get:
      tags:
      - Company Verification Reports
      operationId: GetEntityCompanyVerificationReports
      summary: List an entity's company verification reports
      description: 'Lists company verification reports associated with an entity. Use this endpoint when your integration is working from a known entity ID.

        '
      parameters:
      - $ref: '#/components/parameters/entityId'
      - $ref: '#/components/parameters/collectionCursorNextPageParam'
      - $ref: '#/components/parameters/collectionCursorPreviousPageParam'
      - $ref: '#/components/parameters/collectionLimit'
      - $ref: '#/components/parameters/orderCreatedAt'
      - $ref: '#/components/parameters/orderUpdatedAt'
      responses:
        '200':
          description: Entity Company Verification Reports
          content:
            application/ld+json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Collection'
                - type: object
                  properties:
                    '@context':
                      default: /contexts/CompanyVerificationReport
                    '@id':
                      example: /entities/91ab5678-1234-5678-9abc-def012345678/datasources/mx/company-verification/reports
                    hydra:member:
                      type: array
                      items:
                        $ref: '#/components/schemas/CompanyVerificationReport'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /datasources/mx/company-verification/reports/{reportId}/found-entities:
    get:
      tags:
      - Company Verification Reports
      operationId: GetCompanyVerificationReportFoundEntities
      summary: Get a report's found entities
      description: 'List every person or company identified in the source documents of a

        Mexican Company Verification report, with their cap-table holdings and

        powers of attorney expanded inline.

        '
      parameters:
      - $ref: '#/components/parameters/companyVerificationReportId'
      - $ref: '#/components/parameters/collectionCursorNextPageParam'
      - $ref: '#/components/parameters/collectionCursorPreviousPageParam'
      - $ref: '#/components/parameters/collectionLimit'
      - name: fullName
        in: query
        description: Filter by partial, case-insensitive match on `fullName`.
        example: pérez
        schema:
          type: string
      - name: entityType
        in: query
        description: Filter by entity type.
        schema:
          type: string
          enum:
          - person
          - company
      - name: isActive
        in: query
        description: Filter by whether the entity still holds shares at the report cut-off date.
        schema:
          type: boolean
      - name: order[fullName]
        in: query
        description: Order by full name.
        schema:
          $ref: '#/components/schemas/CollectionOrder'
      - name: order[totalsPercentage]
        in: query
        description: Order by ownership percentage.
        schema:
          $ref: '#/components/schemas/CollectionOrder'
      responses:
        '200':
          description: Company Verification Report Found Entities
          content:
            application/ld+json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/Collection'
                - type: object
                  properties:
                    '@context':
                      default: /contexts/FoundEntity
                    '@id':
                      example: /datasources/mx/company-verification/reports/91ab5678-1234-5678-9abc-def012345678/found-entities
                    hydra:member:
                      type: array
                      items:
                        $ref: '#/components/schemas/CompanyVerificationFoundEntity'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /datasources/mx/company-verification/reports/{reportId}/found-entities/{id}:
    get:
      tags:
      - Company Verification Reports
      operationId: GetCompanyVerificationReportFoundEntity
      summary: Get a specific found entity
      description: Retrieve a single found entity, with its cap-table holdings and powers expanded inline.
      parameters:
      - $ref: '#/components/parameters/companyVerificationReportId'
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Company Verification Report Found Entity
          content:
            application/ld+json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    '@context':
                      default: /contexts/FoundEntity
                - $ref: '#/components/schemas/CompanyVerificationFoundEntity'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    RpcEntidadeProfile:
      type: object
      description: Basic RPC entidade profile information
      properties:
        '@id':
          type: string
          format: iri-reference
          description: RPC entidade IRI reference
          example: /datasources/mx/rpc/entidades/99c13810-868f-482e-a6f1-878254248d27
        '@type':
          type: string
          default: RpcEntidade
        id:
          $ref: '#/components/schemas/RpcEntidadeID'
        fme:
          $ref: '#/components/schemas/RpcEntidadeFme'
        nombreRazonSocial:
          $ref: '#/components/schemas/RpcEntidadeNombreRazonSocial'
    RpcEntidadeFme:
      type:
      - string
      - 'null'
      description: Electronic commercial folio assigned by RPC
      example: N-2000000000
    updatedAt:
      type: string
      description: Date and time the resource was last updated
      example: '2020-01-01T12:15:00.000Z'
    CompanyVerificationFoundEntityPower:
      type: object
      description: A power of attorney granted to a found entity.
      required:
      - id
      - status
      - grantedAt
      - documentSource
      - documentNumber
      properties:
        id:
          type: string
          format: uuid
          example: 64de4567-4567-8901-cdef-123456789012
        status:
          type: string
          description: Whether the power is still in effect at the report cut-off date.
          enum:
          - current
          - expired
          example: current
        power:
          type:
          - string
          - 'null'
          description: 'Canonical power type (for example, `administrative_acts` or

            `lawsuits_and_collections`). `null` when the upstream pipeline

            classified the power as `external` (a reference to another document).

            '
          example: administrative_acts
        grantedAt:
          type: string
          format: date-time
          description: Date the power was granted, as recorded in the source document.
          example: '2020-01-15T00:00:00+00:00'
        expirationDate:
          type:
          - string
          - 'null'
          format: date-time
          description: Date the power expires or expired, when known.
          example: '2025-01-15T00:00:00+00:00'
        expirationSource:
          type:
          - string
          - 'null'
          description: Source used to derive the expiration date (for example, `document` or `inference`).
          example: document
        documentSource:
          type: string
          description: Where the granting document was sourced from.
          example: rpc
        documentNumber:
          type: string
          description: Identifier of the granting document (NCI, protocol number, etc.).
          example: '12345'
        documentGrantingState:
          type:
          - string
          - 'null'
          description: Mexican state where the granting document was issued, when known.
          example: CDMX
        referenceExternal:
          type: boolean
          description: True when the power refers to a separate external document instead of being defined inline.
          example: false
        referenceText:
          type:
          - string
          - 'null'
          description: Verbatim text of the external reference, when present.
        referenceDocumentNumber:
          type:
          - string
          - 'null'
          description: Document number of the external reference, when present.
        exerciseJointlyWith:
          type:
          - string
          - 'null'
          description: Name of the co-grantee with whom the power must be exercised jointly, when applicable.
        exerciseJointlyRequired:
          type: boolean
          description: Whether the power can only be exercised jointly with the co-grantee.
          example: false
        exerciseSubstitutionAllowed:
          type: boolean
          description: Whether the power may be substituted or delegated to another party.
          example: false
        exerciseLimitations:
          type:
          - string
          - 'null'
          description: Free-text limitations recorded in the source document.
        realEstateCanAcquire:
          type: boolean
          description: Whether the grantee may acquire real estate on behalf of the principal.
          example: false
        realEstateCanDispose:
          type: boolean
          description: Whether the grantee may dispose of or sell real estate on behalf of the principal.
          example: false
    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
    createdAt:
      type: string
      description: Date and time the resource was created
      example: '2020-01-01T12:15:00.000Z'
    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
    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
    CompanyVerificationReport:
      type: object
      required:
      - id
      - link
      - rpcEntity
      - extraction
      - files
      - createdAt
      - updatedAt
      properties:
        '@id':
          type: string
          format: iri-reference
          description: Company Verification Report IRI reference
          example: /datasources/mx/company-verification/reports/91ab5678-1234-5678-9abc-def012345678
        '@type':
          type: string
          default: CompanyVerificationReport
        id:
          type: string
          format: uuid
          description: Unique company verification report ID
          example: 91ab5678-1234-5678-9abc-def012345678
        link:
          type: string
          format: iri-reference
          description: Entity associated with the company verification report
          example: /entities/91ab5678-1234-5678-9abc-def012345678
        rpcEntity:
          allOf:
          - $ref: '#/components/schemas/RpcEntidadeProfile'
          description: RPC company profile used for the verification report
        extraction:
          type: string
          format: iri-reference
          description: Extraction that produced the report
          example: /extractions/91106968-1abd-4d64-85c1-4e73d96fb997
        files:
          type: array
          items:
            $ref: '#/components/schemas/File'
          description: Files generated for the company verification report, including PDF and HTML reports when available
        createdAt:
          $ref: '#/components/schemas/createdAt'
        updatedAt:
          $ref: '#/components/schemas/updatedAt'
    RpcEntidadeID:
      type: string
      format: uuid
      description: RPC Entidade ID
      example: 99c13810-868f-482e-a6f1-878254248d27
    RpcEntidadeNombreRazonSocial:
      type:
      - string
      - 'null'
      description: Legal name reported by RPC
      example: FOO BAR, S.A. DE C.V.
    CollectionLimit:
      type: integer
      default: 20
      minimum: 1
      maximum: 1000
    CompanyVerificationFoundEntityCapTableEntry:
      type: object
      description: 'A single cap-table holding row for a found entity, scoped to one

        `(capitalType, series)` bucket. A shareholder that holds both Serie A

        fixed and Serie B fixed yields two entries.

        '
      required:
      - id
      - capitalType
      - shares
      - amount
      - bucketPercentage
      properties:
        id:
          type: string
          format: uuid
          example: 73cd5678-3456-7890-bcde-f01234567890
        capitalType:
          type: string
          description: 'Capital classification: `fixed`, `variable`, or `unspecified`.'
          enum:
          - fixed
          - variable
          - unspecified
          example: fixed
        series:
          type:
          - string
          - 'null'
          description: Capital series identifier (`A`, `B`, …) when the source document reports it.
          example: A
        shares:
          type: integer
          description: Number of shares held in this bucket.
          example: 3000
        amount:
          type: string
          description: Monetary value held in this bucket.
          example: '30000.0000'
        valuePerShare:
          type:
          - string
          - 'null'
          description: Face value per share for this bucket, when known.
          example: '10.0000'
        bucketPercentage:
       

# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/syntage/refs/heads/main/openapi/syntage-company-verification-reports-api-openapi.yml