Syntage Shareholders API

openapi: 3.0.2
info:
  version: '2020-06-28'
  title: Syntage Accounts Payable Insight Shareholders 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: Shareholders
  description: 'Shareholders represent individuals or entities that own shares in a company. This resource provides information about shareholders, their relationships with entities, and the sources of shareholder information.


    ### Shareholder Types

    - **physical**: Individual person shareholders

    - **legal**: Corporate entity shareholders

    - **unknown**: When the shareholder type cannot be determined


    ### Relation Types

    - **shareholders**: Indicates the entity''s shareholders

    - **shareholder_of**: Indicates entities that this shareholder owns shares in


    ### Source Types

    - **manual**: Manually entered shareholder information

    - **rpc_socio**: Information sourced from RPC (Registro Público de Comercio)

    - **company_verification**: Cap-table shareholders synced from a company verification report

    '
paths:
  /entities/{entityId}/shareholders:
    get:
      tags:
      - Shareholders
      operationId: GetEntityShareholders
      summary: List an entity's shareholders
      description: 'Lists shareholders connected to an entity. Use filters to narrow the list by shareholder type, name, or RFC.

        '
      parameters:
      - $ref: '#/components/parameters/entityId'
      - $ref: '#/components/parameters/collectionCursorNextPageParam'
      - $ref: '#/components/parameters/collectionCursorPreviousPageParam'
      - $ref: '#/components/parameters/collectionLimit'
      - $ref: '#/components/parameters/shareholderTypeFilter'
      - $ref: '#/components/parameters/shareholderNameFilter'
      - $ref: '#/components/parameters/shareholderRfcFilter'
      - $ref: '#/components/parameters/orderName'
      - $ref: '#/components/parameters/orderCreatedAt'
      - $ref: '#/components/parameters/orderUpdatedAt'
      responses:
        '200':
          description: Shareholders
          content:
            application/ld+json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/CursorCollection'
                - type: object
                  properties:
                    '@context':
                      default: /contexts/Shareholder
                    '@id':
                      example: /entities/91ab5678-1234-5678-9abc-def012345678/shareholders
                    hydra:member:
                      type: array
                      items:
                        $ref: '#/components/schemas/Shareholder'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      tags:
      - Shareholders
      operationId: CreateEntityShareholder
      summary: Create a new shareholder for an entity
      description: 'Adds manually collected shareholder information to an entity. The request creates a shareholder and the relation between that shareholder and the entity.

        '
      parameters:
      - $ref: '#/components/parameters/entityId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - relationType
              - name
              - shares
              properties:
                relationType:
                  allOf:
                  - $ref: '#/components/schemas/ShareholderRelationType'
                  description: Direction of the ownership relation to create
                name:
                  type: string
                  description: Name of the shareholder to add
                  example: JUAN MANUEL PEREZ GONZALEZ
                rfc:
                  allOf:
                  - $ref: '#/components/schemas/TaxpayerID'
                  description: Shareholder RFC, when available
                  nullable: true
                shares:
                  type: number
                  format: float
                  description: Number of shares represented by the relation
                  minimum: 0.01
                  example: 1500.5
      responses:
        '201':
          description: Shareholder created successfully
          content:
            application/ld+json:
              schema:
                $ref: '#/components/schemas/Shareholder'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /shareholders:
    get:
      tags:
      - Shareholders
      operationId: GetShareholders
      summary: List shareholders
      description: 'Lists shareholders available to the organization. Use this endpoint when you need to search shareholders across entities.

        '
      parameters:
      - $ref: '#/components/parameters/collectionCursorNextPageParam'
      - $ref: '#/components/parameters/collectionCursorPreviousPageParam'
      - $ref: '#/components/parameters/collectionLimit'
      - $ref: '#/components/parameters/shareholderTypeFilter'
      - $ref: '#/components/parameters/shareholderNameFilter'
      - $ref: '#/components/parameters/shareholderRfcFilter'
      - $ref: '#/components/parameters/orderName'
      - $ref: '#/components/parameters/orderCreatedAt'
      - $ref: '#/components/parameters/orderUpdatedAt'
      responses:
        '200':
          description: Shareholders
          content:
            application/ld+json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/CursorCollection'
                - type: object
                  properties:
                    '@context':
                      default: /contexts/Shareholder
                    '@id':
                      example: /shareholders
                    hydra:member:
                      type: array
                      items:
                        $ref: '#/components/schemas/Shareholder'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /shareholders/{id}:
    get:
      tags:
      - Shareholders
      operationId: GetShareholder
      summary: Retrieve a shareholder
      description: 'Retrieves one shareholder by ID.

        '
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Shareholder
          content:
            application/ld+json:
              schema:
                $ref: '#/components/schemas/Shareholder'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      tags:
      - Shareholders
      operationId: UpdateShareholder
      summary: Update a shareholder
      description: 'Updates manually editable shareholder details such as the shareholder''s name or RFC.

        '
      parameters:
      - $ref: '#/components/parameters/resourceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Updated shareholder name
                  example: JUAN MANUEL PEREZ GONZALEZ
                rfc:
                  allOf:
                  - $ref: '#/components/schemas/TaxpayerID'
                  description: Updated shareholder RFC
                  nullable: true
      responses:
        '200':
          description: Shareholder updated successfully
          content:
            application/ld+json:
              schema:
                $ref: '#/components/schemas/Shareholder'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      tags:
      - Shareholders
      operationId: DeleteShareholder
      summary: Delete a shareholder
      description: 'Deletes a shareholder resource.

        '
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '204':
          description: Shareholder deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /shareholders/{shareholderId}/relations:
    get:
      tags:
      - Shareholders
      operationId: GetShareholderRelations
      summary: List shareholder relations
      description: 'Lists the entity relationships for a shareholder, including ownership direction and available ownership details.

        '
      parameters:
      - $ref: '#/components/parameters/shareholderId'
      - $ref: '#/components/parameters/collectionCursorNextPageParam'
      - $ref: '#/components/parameters/collectionCursorPreviousPageParam'
      - $ref: '#/components/parameters/collectionLimit'
      - $ref: '#/components/parameters/relationTypeFilter'
      - $ref: '#/components/parameters/orderShares'
      - $ref: '#/components/parameters/orderOwnership'
      - $ref: '#/components/parameters/orderCreatedAt'
      - $ref: '#/components/parameters/orderUpdatedAt'
      responses:
        '200':
          description: Shareholder Relations
          content:
            application/ld+json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/CursorCollection'
                - type: object
                  properties:
                    '@context':
                      default: /contexts/ShareholderRelation
                    '@id':
                      example: /shareholders/91ab5678-1234-5678-9abc-def012345678/relations
                    hydra:member:
                      type: array
                      items:
                        $ref: '#/components/schemas/ShareholderRelation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /shareholders/{shareholderId}/relations/{relationId}:
    get:
      tags:
      - Shareholders
      operationId: GetShareholderRelation
      summary: Retrieve a shareholder relation
      description: 'Retrieves one shareholder relation by ID.

        '
      parameters:
      - $ref: '#/components/parameters/shareholderId'
      - $ref: '#/components/parameters/relationId'
      responses:
        '200':
          description: Shareholder Relation
          content:
            application/ld+json:
              schema:
                $ref: '#/components/schemas/ShareholderRelation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      tags:
      - Shareholders
      operationId: UpdateShareholderRelation
      summary: Update a shareholder relation
      description: 'Updates manually editable details for a shareholder relation, such as the number of shares.

        '
      parameters:
      - $ref: '#/components/parameters/shareholderId'
      - $ref: '#/components/parameters/relationId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - shares
              properties:
                shares:
                  type: number
                  format: float
                  description: Updated number of shares represented by the relation
                  minimum: 0.01
                  example: 1500.5
      responses:
        '200':
          description: Shareholder Relation updated successfully
          content:
            application/ld+json:
              schema:
                $ref: '#/components/schemas/ShareholderRelation'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      tags:
      - Shareholders
      operationId: DeleteShareholderRelation
      summary: Delete a shareholder relation
      description: 'Deletes the relationship between a shareholder and an entity.

        '
      parameters:
      - $ref: '#/components/parameters/shareholderId'
      - $ref: '#/components/parameters/relationId'
      responses:
        '204':
          description: Shareholder Relation deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /shareholders/{shareholderId}/relations/{relationId}/promote:
    post:
      tags:
      - Shareholders
      operationId: PromoteShareholderRelation
      summary: Promote a shareholder relation
      description: 'Promotes a shareholder relation by creating an entity for the shareholder. Use this when the shareholder should be managed as its own person or company in your integration.

        '
      parameters:
      - $ref: '#/components/parameters/shareholderId'
      - $ref: '#/components/parameters/relationId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - rfc
              properties:
                name:
                  type: string
                  description: Name to use for the new promoted entity
                  example: JUAN MANUEL PEREZ GONZALEZ
                rfc:
                  allOf:
                  - $ref: '#/components/schemas/TaxpayerID'
                  description: RFC to use for the new promoted entity
                datasources:
                  type: array
                  description: Datasources to connect when creating the promoted entity
                  items:
                    type: object
                    required:
                    - name
                    properties:
                      name:
                        type: string
                        enum:
                        - sat
                        - buro_de_credito
                        - rpc
                        - rug
                        - bil
                        description: Datasource to connect to the promoted entity
                        example: sat
                    additionalProperties: true
                  example:
                  - name: sat
                  - name: rpc
      responses:
        '200':
          description: Shareholder Relation promoted successfully
          content:
            application/ld+json:
              schema:
                type: object
                properties:
                  '@type':
                    type: string
                    default: ShareholderPromotedResponse
                  id:
                    type: string
                    format: uuid
                    description: ID of the created entity
                    example: 91ab5678-1234-5678-9abc-def012345678
                  name:
                    type: string
                    description: Name of the created entity
                    example: JUAN MANUEL PEREZ GONZALEZ
                  rfc:
                    allOf:
                    - $ref: '#/components/schemas/TaxpayerID'
                    description: RFC assigned to the created entity
                  onboardingUrl:
                    type: string
                    nullable: true
                    description: Onboarding URL for the created entity, when onboarding is required
                    example: https://api.syntage.com/onboarding/91ab5678-1234-5678-9abc-def012345678
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /shareholders/{shareholderId}/relations/{relationId}/sources:
    get:
      tags:
      - Shareholders
      operationId: GetShareholderRelationSources
      summary: List shareholder relation sources
      description: 'Lists the sources that support a shareholder relation, such as manually entered data or information sourced from RPC.

        '
      parameters:
      - $ref: '#/components/parameters/shareholderId'
      - $ref: '#/components/parameters/relationId'
      - $ref: '#/components/parameters/collectionCursorNextPageParam'
      - $ref: '#/components/parameters/collectionCursorPreviousPageParam'
      - $ref: '#/components/parameters/collectionLimit'
      - $ref: '#/components/parameters/sourceNameFilter'
      - $ref: '#/components/parameters/orderCreatedAt'
      - $ref: '#/components/parameters/orderUpdatedAt'
      responses:
        '200':
          description: Shareholder Relation Sources
          content:
            application/ld+json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/CursorCollection'
                - type: object
                  properties:
                    '@context':
                      default: /contexts/ShareholderRelationsSource
                    '@id':
                      example: /shareholders/91ab5678-1234-5678-9abc-def012345678/relations/82cd9012-3456-7890-abcd-ef1234567890/sources
                    hydra:member:
                      type: array
                      items:
                        $ref: '#/components/schemas/ShareholderRelationsSource'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /shareholders/{shareholderId}/relations/{relationId}/sources/{sourceId}:
    get:
      tags:
      - Shareholders
      operationId: GetShareholderRelationSource
      summary: Retrieve a shareholder relation source
      description: 'Retrieves one source for a shareholder relation.

        '
      parameters:
      - $ref: '#/components/parameters/shareholderId'
      - $ref: '#/components/parameters/relationId'
      - $ref: '#/components/parameters/sourceId'
      responses:
        '200':
          description: Shareholder Relation Source
          content:
            application/ld+json:
              schema:
                $ref: '#/components/schemas/ShareholderRelationsSource'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      tags:
      - Shareholders
      operationId: DeleteShareholderRelationSource
      summary: Delete a shareholder relation source
      description: 'Deletes one source from a shareholder relation.

        '
      parameters:
      - $ref: '#/components/parameters/shareholderId'
      - $ref: '#/components/parameters/relationId'
      - $ref: '#/components/parameters/sourceId'
      responses:
        '204':
          description: Shareholder Relation Source deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    orderShares:
      name: order[shares]
      in: query
      description: Order by number of shares
      schema:
        $ref: '#/components/schemas/CollectionOrder'
    shareholderTypeFilter:
      name: type
      in: query
      description: Filter shareholders by type
      schema:
        type: string
        enum:
        - physical
        - legal
        - unknown
    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
    shareholderId:
      name: shareholderId
      in: path
      required: true
      description: The shareholder ID
      example: 91ab5678-1234-5678-9abc-def012345678
      schema:
        type: string
        format: uuid
    sourceNameFilter:
      name: sourceName
      in: query
      description: Filter sources by name
      schema:
        type: string
        enum:
        - manual
        - rpc_socio
        - company_verification
    orderUpdatedAt:
      name: order[updatedAt]
      in: query
      description: Order by resource update date
      schema:
        $ref: '#/components/schemas/CollectionOrder'
    collectionLimit:
      name: itemsPerPage
      in: query
      required: false
      description: Number of items per page
      schema:
        $ref: '#/components/schemas/CollectionLimit'
    orderOwnership:
      name: order[ownership]
      in: query
      description: Order by ownership percentage
      schema:
        $ref: '#/components/schemas/CollectionOrder'
    col

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