Get Stakeholder

URL Expired

The URL for this request expired after 30 days.

Request Parameters

• issuerId
  string
  required
  The identifier of the issuer owning the stakeholder to retrieve.

• id
  string
  required
  The identifier of the stakeholder to retrieve.

Responses

200 A successful response.

• object
  The response from the Get Stakeholder endpoint.
  • stakeholder
    object
    The requested stakeholder from the specified issuer.
    • id
      string
      length ≤ 50
      The identifier of the stakeholder.
    • issuerId
      string
      length ≤ 50
      An identifier for the issuer related to the stakeholder.
    • fullName
      string
      length ≤ 1000
      The stakeholder's full legal name.
    • email
      string
      length ≤ 1000
      The stakeholder's email.
    • employeeId
      string
      length ≤ 256
      An employee identifier for the stakeholder, if it exists.
    • relationship
      string
      enum
      The relationship of the stakeholder with the issuer. This will not be set for all stakeholders.
    • group
      string
      length ≤ 1000
      The group to which the stakeholder belongs. This will not be set for all stakeholders.
    • entityType
      string
      enum
      length ≤ 1000
      The entity type of the stakeholder. This will not be set for all stakeholders.
    • address
      object
      The address of the stakeholder. This will not be set for all stakeholders.

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

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

Example Response

{
  "stakeholder": {
    "id": "4902",
    "issuerId": "7",
    "fullName": "Emily Wilson",
    "email": "emily@esharesinc.com",
    "employeeId": "1213511",
    "relationship": "STAKEHOLDER_RELATIONSHIP_EMPLOYEE",
    "group": "Founders",
    "entityType": "INDIVIDUAL",
    "address": {
      "country": "USA"
    }
  }
}