List Certificates
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
Request Parameters
issuerId
- Type: string
- Required: Yes
- Description: The identifier of the issuer owning the certificates to retrieve.
pageSize
- Type: int32
- Description: The maximum number of certificates to return. The service may return fewer than this value. If unspecified, at most 25 funds will be returned. The maximum value is 50; values above 50 will be coerced to 50.
pageToken
- Type: string
- Description: A page token received as
nextPageTokenin a previous List Certificates response. Provide this to retrieve the subsequent page. When paginating, all other parameters provided tocertificatesmust match the call that provided the page token.
lastModifiedDatetimeAfter
- Type: string
- Description: 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
- Type: string
- Description: 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'.
Response
200 A successful response.
- Type: object
- Description: The response from the List Certificates endpoint.
certificates
- Type: array of objects
- Description: The vesting schedules from the specified issuer.
Certificate Object
- Type: object
- Description: A certificate is a record of ownership of a company's shares.
| Field | Type | Description |
|---|---|---|
| id | string | The identifier of the certificate (length ≤ 50). |
| securityId | string | The UUID of the certificate. Use this to cross-reference with the List Transactions API (length ≤ 50). |
| shareClassId | string | The UUID of the share class for this certificate (length ≤ 50). May be absent if there is no associated share class. |
| vestingScheduleTemplateId | string | The UUID of the vesting schedule template (length ≤ 50). May be absent if the certificate has no vesting schedule. |
| issuerId | string | The identifier of the issuer owning the certificate (length between 1 and 50). |
| stakeholderId | string | The identifier of the stakeholder holding the certificate (length ≤ 50). |
| shareClassName | string | The name of the share class for the shares held in this certificate (length ≤ 100). |
| issueDate | object | The date the certificate was issued. |
| quantity | object | The number of shares in the certificate. |
| securityLabel | string | The label representing this security (length ≤ 50). |
| pricePerShare | object | The cost of each share in the certificate. |
| canceledDate | object | The date the certificate was canceled. |
| canceledQuantity | object | The number of shares in the certificate that were canceled. |
| returnedToPoolQuantity | object | The number of shares in the certificate that were returned to the pool. |
| returnedToTreasuryQuantity | object | The number of shares in the certificate that were annulled, but not returned to the pool. |
| lastModifiedDatetime | object | The date and time when the certificate was last modified. |
| precededBy | object | The origin/history of the certificate, describing which prior security (if any) it was issued from and why. |
| dividendAccrualStartDate | object | The date from which dividends start accruing on the security. |
| returnedInvestedCapital | object | The amount of invested capital that was returned to the stakeholder upon repurchase or redemption of the certificate. |
| unreturnedInvestedCapital | object | The amount of invested capital that has not yet been returned to the stakeholder upon repurchase or redemption of the certificate. |
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.
Example CURL Request
curl --request GET \
--url https://mock-api.carta.com/v1alpha1/issuers/issuerId/certificates \
--header 'accept: application/json'
Sample Response
{
"certificates": [
{
"id": "34",
"securityId": "d4e5f6a7-b8c9-0123-defa-234567890123",
"shareClassId": "f2a3b4c5-d6e7-8901-fabc-012345678901",
"vestingScheduleTemplateId": "a3b4c5d6-e7f8-9012-abcd-123456789abc",
"issuerId": "7",
"stakeholderId": "4903",
"shareClassName": "Series Seed Preferred",
"issueDate": {
"value": "2013-04-10"
},
"dividendAccrualStartDate": {
"value": "2013-04-10"
},
"quantity": {
"value": "150000"
},
"securityLabel": "CS-42",
"pricePerShare": {
"currencyCode": {
"value": "USD"
},
"amount": {
"value": "0.27"
}
},
"returnedInvestedCapital": {
"currencyCode": {
"value": "USD"
},
"amount": {
"value": "10000.00"
}
},
"lastModifiedDatetime": {
"value": "2024-07-30T09:31:57.000000Z"
}
}
],
"nextPageToken": "NDY="
}