Skip to main content
GET
/
datasources
/
mx
/
company-verification
/
reports
/
{reportId}
/
found-entities
Get a report's found entities
curl --request GET \
  --url https://api.syntage.com/datasources/mx/company-verification/reports/{reportId}/found-entities \
  --header 'X-API-Key: <api-key>'
{
  "@context": "/contexts/FoundEntity",
  "@id": "/datasources/mx/company-verification/reports/91ab5678-1234-5678-9abc-def012345678/found-entities",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "id": "82bc6789-2345-6789-abcd-ef0123456789",
      "fullName": "Juan Pérez García",
      "nameVariations": [
        "Juan Perez Garcia",
        "J. Pérez García"
      ],
      "entityType": "person",
      "isActive": true,
      "holdings": [
        {
          "id": "73cd5678-3456-7890-bcde-f01234567890",
          "capitalType": "fixed",
          "shares": 3000,
          "amount": "30000.0000",
          "bucketPercentage": "60.0000",
          "series": "A",
          "valuePerShare": "10.0000"
        }
      ],
      "powers": [
        {
          "id": "64de4567-4567-8901-cdef-123456789012",
          "status": "current",
          "grantedAt": "2020-01-15T00:00:00+00:00",
          "documentSource": "rpc",
          "documentNumber": "12345",
          "power": "administrative_acts",
          "expirationDate": "2025-01-15T00:00:00+00:00",
          "expirationSource": "document",
          "documentGrantingState": "CDMX",
          "referenceExternal": false,
          "referenceText": "<string>",
          "referenceDocumentNumber": "<string>",
          "exerciseJointlyWith": "<string>",
          "exerciseJointlyRequired": false,
          "exerciseSubstitutionAllowed": false,
          "exerciseLimitations": "<string>",
          "realEstateCanAcquire": false,
          "realEstateCanDispose": false
        }
      ],
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z",
      "@id": "/datasources/mx/company-verification/reports/91ab5678-1234-5678-9abc-def012345678/found-entities/82bc6789-2345-6789-abcd-ef0123456789",
      "@type": "FoundEntity",
      "totalsShares": 5000,
      "totalsAmount": "50000.0000",
      "totalsPercentage": "25.0000",
      "firstAppearanceDate": "2020-01-15"
    }
  ],
  "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
      }
    ]
  }
}

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
reportId
string<uuid>
required

Identifier of the Company Verification report.

Query Parameters

​
id[lt]
string

Collection cursor pointer to the next page

​
id[gt]
string

Collection cursor pointer to the previous page

​
itemsPerPage
integer
default:20

Number of items per page

Required range: 1 <= x <= 1000
​
fullName
string

Filter by partial, case-insensitive match on fullName.

​
entityType
enum<string>

Filter by entity type.

Available options:
person,
company
​
isActive
boolean

Filter by whether the entity still holds shares at the report cut-off date.

​
order[fullName]
enum<string>

Order by full name.

Available options:
asc,
desc
Example:

"asc"

​
order[totalsPercentage]
enum<string>

Order by ownership percentage.

Available options:
asc,
desc
Example:

"asc"

Response

Company Verification Report Found Entities

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

"/datasources/mx/company-verification/reports/91ab5678-1234-5678-9abc-def012345678/found-entities"

​
@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