Skip to main content
GET
Get a report's found entities

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