API · Manage · Equity
Create a share ledger entry.
Polymorphic endpoint covering the full equity-mutation surface, including convertible instruments:
- `issuance`, `transfer`, `cancellation`, `repurchase` — share-affecting mutations. Require share_class_id and quantity. - `safe_grant` — record a SAFE (Simple Agreement for Future Equity). Requires principal_amount and safe_type; optional discount_rate, valuation_cap, mfn. Does not yet affect outstanding shares. - `note_grant` — record a convertible promissory note. Requires principal_amount and interest_rate; optional discount_rate, valuation_cap, maturity_date. Does not yet affect outstanding shares. - `safe_conversion` / `note_conversion` — convert a previously recorded SAFE or note into preferred shares at a priced round. Requires references_entry_id (the original safe_grant / note_grant), share_class_id, and quantity.
The canonical equity mutation — named convenience routes (/share_ledger/issue, /share_ledger/transfer) are sugar over this.
Returns 202 Accepted. On completion, emits one of: grant.issued, share_class.created, valuation.created, share_ledger.entry_recorded. Subscribe via `POST /v1/webhook_endpoints` to consume.
Last updated
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
kindstringRequiredOne of
"issuance""transfer""cancellation""repurchase""safe_grant""safe_conversion""note_grant""note_conversion"from_stakeholder_idstringOptionalto_stakeholder_idstringOptionalquantityintegerOptionalRequired for share-affecting kinds and conversions; null for safe_grant / note_grant (the underlying SAFE/note has no share quantity until conversion).
considerationstringOptionaltransaction_datestring<date>Requiredprincipal_amountobjectOptionalInvestment principal. Required for safe_grant and note_grant.
amountintegerRequiredInteger in smallest unit. 100 = USD 1.00.
currencystringRequiredISO 4217 alpha-3, lower-cased.
safe_typestringOptionalSAFE variant. Required for safe_grant.
One of
"pre_money""post_money""post_money_capped""mfn_only"interest_ratenumberOptionalAnnual interest rate as a decimal (e.g. 0.05 for 5%). Required for note_grant.
discount_ratenumberOptionalConversion discount as a decimal (e.g. 0.20 for 20%). Optional for safe_grant / note_grant.
valuation_capobjectOptionalConversion valuation cap. Optional for safe_grant / note_grant.
amountintegerRequiredInteger in smallest unit. 100 = USD 1.00.
currencystringRequiredISO 4217 alpha-3, lower-cased.
mfnbooleanOptionalMost-favored-nation clause. Optional for safe_grant.
maturity_datestring<date>OptionalNote maturity date. Optional for note_grant.
references_entry_idstringOptionalThe safe_grant or note_grant ledger entry being converted. Required for safe_conversion / note_conversion.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
Request
curl -X POST "https://api.mattermode.com/v1/entities/{id}/share_ledger" \ -H "Content-Type: application/json" \ -d '{ "kind": "issuance", "share_class_id": "cls_2KdNrLpA", "from_stakeholder_id": "string", "to_stakeholder_id": "string", "quantity": 1, "price_per_share": { "amount": 50000, "currency": "usd" }, "consideration": "string", "transaction_date": "2026-04-25", "principal_amount": { "amount": 50000, "currency": "usd" }, "safe_type": "pre_money", "interest_rate": 0, "discount_rate": 0, "valuation_cap": { "amount": 50000, "currency": "usd" }, "mfn": false, "maturity_date": "2026-04-25", "references_entry_id": "string" }'const body = JSON.stringify({ "kind": "issuance", "share_class_id": "cls_2KdNrLpA", "from_stakeholder_id": "string", "to_stakeholder_id": "string", "quantity": 1, "price_per_share": { "amount": 50000, "currency": "usd" }, "consideration": "string", "transaction_date": "2026-04-25", "principal_amount": { "amount": 50000, "currency": "usd" }, "safe_type": "pre_money", "interest_rate": 0, "discount_rate": 0, "valuation_cap": { "amount": 50000, "currency": "usd" }, "mfn": false, "maturity_date": "2026-04-25", "references_entry_id": "string"})fetch("https://api.mattermode.com/v1/entities/{id}/share_ledger", { method: "POST", headers: { "Content-Type": "application/json" }, body})package mainimport ( "fmt" "net/http" "io/ioutil" "strings")func main() { url := "https://api.mattermode.com/v1/entities/{id}/share_ledger" body := strings.NewReader(`{ "kind": "issuance", "share_class_id": "cls_2KdNrLpA", "from_stakeholder_id": "string", "to_stakeholder_id": "string", "quantity": 1, "price_per_share": { "amount": 50000, "currency": "usd" }, "consideration": "string", "transaction_date": "2026-04-25", "principal_amount": { "amount": 50000, "currency": "usd" }, "safe_type": "pre_money", "interest_rate": 0, "discount_rate": 0, "valuation_cap": { "amount": 50000, "currency": "usd" }, "mfn": false, "maturity_date": "2026-04-25", "references_entry_id": "string" }`) req, _ := http.NewRequest("POST", url, body) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body))}import requestsheaders = { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b",}payload = { "kind": "issuance", "share_class_id": "cls_2KdNrLpA", "from_stakeholder_id": "string", "to_stakeholder_id": "string", "quantity": 1, "price_per_share": { "amount": 50000, "currency": "usd" }, "consideration": "string", "transaction_date": "2026-04-25", "principal_amount": { "amount": 50000, "currency": "usd" }, "safe_type": "pre_money", "interest_rate": 0, "discount_rate": 0, "valuation_cap": { "amount": 50000, "currency": "usd" }, "mfn": false, "maturity_date": "2026-04-25", "references_entry_id": "string"}resp = requests.post( "https://api.mattermode.com/v1/entities/ent_Nq3KcAbc/share_ledger", headers=headers, json=payload,)resp.raise_for_status()print(resp.json())import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.net.http.HttpResponse.BodyHandlers;import java.time.Duration;import java.net.http.HttpRequest.BodyPublishers;var body = BodyPublishers.ofString("""{ "kind": "issuance", "share_class_id": "cls_2KdNrLpA", "from_stakeholder_id": "string", "to_stakeholder_id": "string", "quantity": 1, "price_per_share": { "amount": 50000, "currency": "usd" }, "consideration": "string", "transaction_date": "2026-04-25", "principal_amount": { "amount": 50000, "currency": "usd" }, "safe_type": "pre_money", "interest_rate": 0, "discount_rate": 0, "valuation_cap": { "amount": 50000, "currency": "usd" }, "mfn": false, "maturity_date": "2026-04-25", "references_entry_id": "string"}""");HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder() .uri(URI.create("https://api.mattermode.com/v1/entities/{id}/share_ledger")) .header("Content-Type", "application/json") .POST(body) .build();try { HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString()); System.out.println("Status code: " + response.statusCode()); System.out.println("Response body: " + response.body());} catch (Exception e) { e.printStackTrace();}using System;using System.Net.Http;using System.Text;var body = new StringContent("""{ "kind": "issuance", "share_class_id": "cls_2KdNrLpA", "from_stakeholder_id": "string", "to_stakeholder_id": "string", "quantity": 1, "price_per_share": { "amount": 50000, "currency": "usd" }, "consideration": "string", "transaction_date": "2026-04-25", "principal_amount": { "amount": 50000, "currency": "usd" }, "safe_type": "pre_money", "interest_rate": 0, "discount_rate": 0, "valuation_cap": { "amount": 50000, "currency": "usd" }, "mfn": false, "maturity_date": "2026-04-25", "references_entry_id": "string"}""", Encoding.UTF8, "application/json");var client = new HttpClient();var response = await client.PostAsync("https://api.mattermode.com/v1/entities/{id}/share_ledger", body);var responseBody = await response.Content.ReadAsStringAsync();curl --request POST 'https://api.mattermode.com/v1/entities/ent_Nq3KcAbc/share_ledger' \ --header 'Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc' \ --header 'Matter-Version: 2026-06-10' \ --header 'Idempotency-Key: ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b' \ --header 'Content-Type: application/json' \ --data '{ "kind": "issuance", "share_class_id": "cls_2KdNrLpA", "from_stakeholder_id": "string", "to_stakeholder_id": "string", "quantity": 1, "price_per_share": { "amount": 50000, "currency": "usd" }, "consideration": "string", "transaction_date": "2026-04-25", "principal_amount": { "amount": 50000, "currency": "usd" }, "safe_type": "pre_money", "interest_rate": 0, "discount_rate": 0, "valuation_cap": { "amount": 50000, "currency": "usd" }, "mfn": false, "maturity_date": "2026-04-25", "references_entry_id": "string"}'const response = await fetch("https://api.mattermode.com/v1/entities/ent_Nq3KcAbc/share_ledger", { method: "POST", headers: { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b", "Content-Type": "application/json", }, body: JSON.stringify({ "kind": "issuance", "share_class_id": "cls_2KdNrLpA", "from_stakeholder_id": "string", "to_stakeholder_id": "string", "quantity": 1, "price_per_share": { "amount": 50000, "currency": "usd" }, "consideration": "string", "transaction_date": "2026-04-25", "principal_amount": { "amount": 50000, "currency": "usd" }, "safe_type": "pre_money", "interest_rate": 0, "discount_rate": 0, "valuation_cap": { "amount": 50000, "currency": "usd" }, "mfn": false, "maturity_date": "2026-04-25", "references_entry_id": "string" }),});if (!response.ok) { throw new Error(`Matter API ${response.status}: ${await response.text()}`);}const data = await response.json();console.log(data);Response
application/json{
"id": "string",
"object": "share_ledger_entry",
"entity_id": "ent_Nq3KcAbc",
"kind": "issuance",
"share_class_id": "cls_2KdNrLpA",
"from_stakeholder_id": "string",
"to_stakeholder_id": "string",
"quantity": 1,
"price_per_share": {
"amount": 50000,
"currency": "usd"
},
"consideration": "string",
"transaction_date": "2026-04-25",
"principal_amount": {
"amount": 0,
"currency": "usd"
},
"safe_type": "pre_money",
"interest_rate": 0,
"discount_rate": 0,
"valuation_cap": {
"amount": 0,
"currency": "usd"
},
"mfn": false,
"maturity_date": "2026-04-25",
"references_entry_id": "string",
"document_ids": [
"string"
],
"metadata": {},
"created": 1745539200,
"updated": 1745539200,
"livemode": false
}{
"type": "https://mattermode.com/docs/errors/invalid_request",
"title": "Invalid request",
"status": 400,
"code": "invalid_request",
"detail": "Request body could not be parsed as JSON.",
"doc_url": "https://mattermode.com/docs/guides/errors#invalid_request",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/authentication_required",
"title": "Authentication required",
"status": 401,
"code": "authentication_required",
"detail": "No bearer token was supplied. Pass `Authorization: Bearer sk_live_...` on every request.",
"doc_url": "https://mattermode.com/docs/guides/errors#authentication_required",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/validation_failed",
"title": "Validation failed",
"status": 422,
"code": "validation_failed",
"detail": "One or more fields failed validation. See `errors[]`.",
"doc_url": "https://mattermode.com/docs/guides/errors#validation_failed",
"request_id": "req_Qw9xYz8A",
"errors": [
{
"field": "founders[0].equity",
"code": "out_of_range",
"message": "Equity must sum to 100% across all founders."
}
]
}{
"type": "https://mattermode.com/docs/errors/rate_limit_exceeded",
"title": "Rate limit exceeded",
"status": 429,
"code": "rate_limit_exceeded",
"detail": "Request rate exceeded for this key. Retry after `retry_after` seconds or honor the `Retry-After` header.",
"doc_url": "https://mattermode.com/docs/guides/errors#rate_limit_exceeded",
"request_id": "req_Qw9xYz8A",
"retry_after": 30
}