Skip to main content
GET
/
entities
/
{entityId}
/
insights
/
shareholders
Get shareholders
curl --request GET \
  --url https://api.syntage.com/entities/{entityId}/insights/shareholders \
  --header 'X-API-Key: <api-key>'
{
  "@context": "/contexts/GetShareholdersInsight",
  "@id": "/entities/91ab5678-1234-5678-9abc-def012345678/insights/shareholders?relations.relationType=shareholders",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "id": "91ab5678-1234-5678-9abc-def012345678",
      "name": "EJEMPLO HOLDINGS, S.A. DE C.V.",
      "rfc": "EHO240101AB1",
      "shares": "500",
      "percentage": "50.00",
      "relationId": "82cd9012-3456-7890-abcd-ef1234567890",
      "sources": "company_verification",
      "entityId": "3f6b8b52-60f3-4af1-8459-6f23a0a0c944",
      "sourceId": "11d2c236-bbd0-4024-8e59-089aa0d4359d",
      "scores": [
        {
          "id": "76e6d0ec-9e6a-40c7-85e2-4ce02b5d9568",
          "source": "buro_de_credito",
          "type": "informe_buro",
          "score": "533",
          "generatedAt": "2024-10-04T20:53:09+00:00",
          "metadata": {}
        }
      ]
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "<string>",
    "@type": "hydra:PartialCollectionView",
    "hydra:first": "<string>",
    "hydra:next": "<string>",
    "hydra:last": "<string>"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}
To export this insight, use Insight Export with shareholders as the insight name and pass the relation type as options[relations.relationType].

Authorizations

​
X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

​
entityId
string<uuid>
required

Query Parameters

​
relations.relationType
enum<string>
required

Shareholder relation direction to return

Available options:
shareholders,
shareholder_of
​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
itemsPerPage
integer
default:1000

Number of items per page

Required range: 1 <= x <= 1000

Response

Shareholders insight

​
@context
string
default:/contexts/GetShareholdersInsight
​
@id
string
Example:

"/entities/91ab5678-1234-5678-9abc-def012345678/insights/shareholders?relations.relationType=shareholders"

​
@type
string
default:hydra:Collection
​
hydra:member
object[]
​
hydra:totalItems
integer

Total number of items found

Required range: x >= 0
Example:

1

​
hydra:view
object

Pagination information

​
hydra:search
object