List Certificates

URL Expired

The URL for this request expired after 30 days.

Parameters

• portfolioId
  Type: string
  Required: Yes
  The identifier of the portfolio holding the certificates to retrieve.

• issuerId
  Type: string
  Required: Yes
  The identifier of the issuer that has issued the certificates to retrieve.

• pageSize
  Type: 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 50; values above 50 will be coerced to 50.

• pageToken
  Type: string
  A page token received as nextPageToken in a previous List Certificates response. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to certificates must match the call that provided the page token.

• lastModifiedDatetimeAfter
  Type: 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
  Type: 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'.

Responses

200 A successful response.

• object
  The response from the List Certificates endpoint.

• certificates

  • Type: array of objects
    The vesting schedules from the specified portfolio.

• certificates

  • Type: object
    A certificate is a record of ownership of a company's shares.

Certificate Fields

• id
  Type: string
  Length: ≤ 50
  The identifier of the certificate.

• issuerId
  Type: string
  Length: between 1 and 50
  The identifier of the issuer owning the certificate.

• stakeholderId
  Type: string
  Length: ≤ 50
  The identifier of the stakeholder that holds the certificate.

• shareClassName
  Type: string
  Length: ≤ 100
  The name of the share class for the shares held in this certificate.

• issueDate

  • Type: object
    The date the certificate was issued.

• quantity

  • Type: object
    The number of shares in the certificate.

• securityLabel
  Type: string
  Length: ≤ 50
  The label representing this security (certificate).

• pricePerShare

  • Type: object
    The cost of each share in the certificate.

• canceledDate

  • Type: object
    The date when this certificate was canceled.

• canceledQuantity

  • Type: object
    The number of shares in the certificate that were canceled.

• returnedToPoolQuantity

  • Type: object
    The number of shares in the certificate that were returned to the pool.

• returnedToTreasuryQuantity

  • Type: object
    The number of shares in the certificate that were annulled, but not returned to the pool.

• lastModifiedDatetime

  • Type: object
    The date and time when the certificate was last modified.

• returnedInvestedCapital

  • Type: object
    The amount of invested capital that was returned to the stakeholder upon repurchase or redemption of the certificate.

• unreturnedInvestedCapital

  • Type: object
    The amount of invested capital that has not yet been returned to the stakeholder upon repurchase or redemption of the certificate.

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

Error Responses

• 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 Request

curl --request GET \
     --url https://mock-api.carta.com/v1alpha1/portfolios/portfolioId/issuers/issuerId/certificates \
     --header 'accept: application/json'

Example Response

{
  "certificates": [
    {
      "id": "2942",
      "issuerId": "7",
      "stakeholderId": "6113",
      "shareClassName": "Common",
      "issueDate": {
        "value": "2017-09-04"
      },
      "quantity": {
        "value": "1000"
      },
      "securityLabel": "CS-18",
      "pricePerShare": {
        "currencyCode": {
          "value": "USD"
        },
        "amount": {
          "value": "0.05"
        }
      },
      "lastModifiedDatetime": {
        "value": "2024-07-30T09:31:57.000000Z"
      }
    }
  ],
  "nextPageToken": "NDY="
}