List Certificates

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

firmId

string

required

The identifier of the firm.

fundId

string

required

The identifier of the fund or - to list certificates across all funds under the firm specified by firmId.

investmentId

string

required

The identifier of the investment or - to list certificates across all company investments under the fund specified by firmId and fundId.

asOfDate

string

Deprecated

Return certificates with issue dates on or after this date, specified as an ISO 8601 extended format calendar date, i.e. 'YYYY-MM-DD'.

pageSize

int32

The maximum number of certificates to return. The service may return fewer than this value.

If unspecified, at most 25 certificates will be returned.

The maximum value is 100; values above 100 will be coerced to 100.

pageToken

string

A page token received as nextPageToken in a previous ListCertificates response. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCertificates must match the call that provided the page token.

lastModifiedDatetimeAfter

string

Return certificates that were last modified on or after this date and time. Uses UTC and is specified in ISO 8601 format, i.e. 'YYYY-MM-DDThh:mm:ssZ'.

lastModifiedDatetimeBefore

string

Return certificates that were last modified on or before this date and time. Uses UTC and is specified in ISO 8601 format, i.e. 'YYYY-MM-DDThh:mm:ssZ'.

``200 A successful response.

object

The response from the ListCertificates endpoint.

certificates

array of objects

The certificates returned in the ListCertificates response.

certificates

object

A certificate.

firmId

string

length between 1 and 50

The identifier of the investment firm that holds the certificate.

firmName

string

length between 1 and 1000

The name of the investment firm that holds the certificate.

fundId

string

length between 1 and 50

The identifier of the investment fund that manages the certificate.

fundName

string

length between 1 and 1000

The name of the investment fund that manages the certificate.

companyId

string

length between 1 and 50

The identifier of the company that issued the certificate.

companyName

string

length between 1 and 1000

The name of the company that issued the certificate.

currentStakeholderId

string

length between 1 and 50

The identifier of the stakeholder currently holding the certificate.

id

string

length between 1 and 50

The identifier of the certificate.

securityLabel

string

length between 1 and 50

The label representing the certificate.

shareClassId

string

length between 1 and 50

The identifier of the share class of the shares held in the certificate.

shareClassName

string

length between 1 and 1000

The name of the share class of the shares held in the certificate.

issueDate

object

The date the certificate was issued.

issueDate object

quantity

object

required

The number of shares in the certificate.

quantity object

pricePerShare

object

required

The price of each share in the certificate.

pricePerShare object

canceledDate

object

The date the certificate was canceled.

canceledDate object

terminationDate

object

The date the certificate was terminated.

terminationDate object

lastModifiedDatetime

object

The date and time when the certificate was last modified.

lastModifiedDatetime object

nextPageToken

string

Submit the nextPageToken string as pageToken in a subsequent request to retrieve the next page. If the ListCertificates response omits nextPageToken, then there are no subsequent pages.

``400 Returned if required fields are omitted or if provided fields fail validation.

``401 Returned if a valid Authorization header has not been included with the request.

``403 Returned when the user does not have permission to access the resource.

``500 Returned if an unexpected internal server error is encountered.

``default An unexpected error response.

Updatedabout 2 months ago