API · Manage · Sessions
Create a stakeholder portal session.
Returns a hosted URL where a stakeholder can accept grants, sign 83(b) elections, download signed documents, and view vesting progress. Driven entirely by the stakeholder's existing grants and documents — integrator configuration is intentionally minimal.
Last updated
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
stakeholder_idstringRequiredreturn_urlstring<uri>Requiredscopearray<string>Optionalttl_secondsintegerOptionalmetadataobjectOptionalFlat string-to-string map. Up to 50 keys. Keys: max 40 chars, charset
[A-Za-z0-9_\\-.]. Values: max 500 chars. Keys prefixed matter_ are reserved
for platform use. Metadata is retrievable but not filterable via query params.
Response Body
application/json
application/problem+json
application/problem+json
Request
curl -X POST "https://api.mattermode.com/v1/stakeholder_portal_sessions" \ -H "Content-Type: application/json" \ -d '{ "stakeholder_id": "stk_7Hpx9WxY", "return_url": "https://your.app/webhooks/matter", "scope": [ "grants", "documents", "vesting", "tax_elections" ], "ttl_seconds": 3600, "metadata": {} }'const body = JSON.stringify({ "stakeholder_id": "stk_7Hpx9WxY", "return_url": "https://your.app/webhooks/matter", "scope": [ "grants", "documents", "vesting", "tax_elections" ], "ttl_seconds": 3600, "metadata": {}})fetch("https://api.mattermode.com/v1/stakeholder_portal_sessions", { method: "POST", headers: { "Content-Type": "application/json" }, body})package mainimport ( "fmt" "net/http" "io/ioutil" "strings")func main() { url := "https://api.mattermode.com/v1/stakeholder_portal_sessions" body := strings.NewReader(`{ "stakeholder_id": "stk_7Hpx9WxY", "return_url": "https://your.app/webhooks/matter", "scope": [ "grants", "documents", "vesting", "tax_elections" ], "ttl_seconds": 3600, "metadata": {} }`) 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 = { "stakeholder_id": "stk_7Hpx9WxY", "return_url": "https://your.app/webhooks/matter", "scope": [ "grants", "documents", "vesting", "tax_elections" ], "ttl_seconds": 3600, "metadata": {}}resp = requests.post( "https://api.mattermode.com/v1/stakeholder_portal_sessions", 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("""{ "stakeholder_id": "stk_7Hpx9WxY", "return_url": "https://your.app/webhooks/matter", "scope": [ "grants", "documents", "vesting", "tax_elections" ], "ttl_seconds": 3600, "metadata": {}}""");HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder() .uri(URI.create("https://api.mattermode.com/v1/stakeholder_portal_sessions")) .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("""{ "stakeholder_id": "stk_7Hpx9WxY", "return_url": "https://your.app/webhooks/matter", "scope": [ "grants", "documents", "vesting", "tax_elections" ], "ttl_seconds": 3600, "metadata": {}}""", Encoding.UTF8, "application/json");var client = new HttpClient();var response = await client.PostAsync("https://api.mattermode.com/v1/stakeholder_portal_sessions", body);var responseBody = await response.Content.ReadAsStringAsync();curl --request POST 'https://api.mattermode.com/v1/stakeholder_portal_sessions' \ --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 '{ "stakeholder_id": "stk_7Hpx9WxY", "return_url": "https://your.app/webhooks/matter", "scope": [ "grants", "documents", "vesting", "tax_elections" ], "ttl_seconds": 3600, "metadata": {}}'const response = await fetch("https://api.mattermode.com/v1/stakeholder_portal_sessions", { 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({ "stakeholder_id": "stk_7Hpx9WxY", "return_url": "https://your.app/webhooks/matter", "scope": [ "grants", "documents", "vesting", "tax_elections" ], "ttl_seconds": 3600, "metadata": {} }),});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": "stakeholder_portal_session",
"stakeholder_id": "stk_7Hpx9WxY",
"url": "https://your.app/webhooks/matter",
"return_url": "https://your.app/webhooks/matter",
"scope": [
"grants"
],
"metadata": {},
"expires_at": 1745539200,
"created": 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"
}