Get Certificate

URL Expired

The URL for this request expired after 30 days.

Certificate Schema

Fields

• issuerId (string) - required: The identifier of the issuer owning the certificate to retrieve.
• id (string) - required: The identifier of the certificate to retrieve.

Responses

``200 A successful response.

• certificate (object) - The requested certificate from the specified issuer.
  • id (string) - length ≤ 50: The identifier of the certificate.
  • securityId (string) - length ≤ 50: The UUID of the certificate. Use this to cross-reference with the List Transactions API.
  • shareClassId (string) - length ≤ 50: The UUID of the share class for this certificate. May be absent if there is no associated share class.
  • vestingScheduleTemplateId (string) - length ≤ 50: The UUID of the vesting schedule template used by this certificate. May be absent if the certificate has no vesting schedule.
  • stakeholderId (string) - length ≤ 50: The identifier of the stakeholder holding the certificate.
  • shareClassName (string) - length ≤ 100: The name of the share class for the shares held in this certificate.
  • issueDate (object): The date the certificate was issued.
  • issueDate object
    • quantity (object): The number of shares in the certificate.
    • quantity object
  • securityLabel (string) - length ≤ 50: The label representing this security (certificate).
  • pricePerShare (object): The cost of each share in the certificate.
  • pricePerShare object
  • canceledDate (object): The date the certificate was canceled.
  • canceledDate object
  • canceledQuantity (object): The number of shares in the certificate that were canceled.
  • canceledQuantity object
  • returnedToPoolQuantity (object): The number of shares in the certificate that were returned to the pool.
  • returnedToPoolQuantity object
  • returnedToTreasuryQuantity (object): The number of shares in the certificate that were annulled, but not returned to the pool.
  • returnedToTreasuryQuantity object
  • lastModifiedDatetime (object): The date and time when the certificate was last modified.
  • lastModifiedDatetime object
  • precededBy (object): The origin/history of the certificate, describing which prior security (if any) it was issued from and why. Needed to distinguish primary vs secondary issuances for cap table summaries.
  • precededBy object
  • dividendAccrualStartDate (object): The date from which dividends start accruing on the security.
  • dividendAccrualStartDate object
  • returnedInvestedCapital (object): The amount of invested capital that was returned to the stakeholder upon repurchase or redemption of the certificate.
  • returnedInvestedCapital object
  • unreturnedInvestedCapital (object): The amount of invested capital that has not yet been returned to the stakeholder upon repurchase or redemption of the certificate.
  • unreturnedInvestedCapital object

Error Codes

• ``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/id \
     --header 'accept: application/json'

Example JSON Response

{
  "certificate": {
    "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"
    }
  }
}