API · Create · Tokens
Create a portal credential.
Vault a founder's login for a government filing portal so Matter's trusted tier can drive an authenticated session on their behalf. The credential payload is a closed per-portal shape — each portal names exactly the secrets its login takes; unknown portals and missing fields are rejected.
Security model. - The payload is AES-256-GCM envelope-encrypted at rest, bound to the calling Account, mode, Entity, and portal — it cannot be read across any of those boundaries, cryptographically. - Plaintext is never returned after this single request, never logged, and never appears in webhook payloads. Only a last4-style username_hint is stored in the clear for display. - Decryption happens only on Matter's trusted tier, per browser session, and the plaintext is wiped after the login keystrokes are driven. No authenticated session is opened for a portal until that portal's counsel clearance exists.
Last updated
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
entity_idstringRequiredThe Entity this credential files for.
credentialobjectRequiredThe closed per-portal payload. portal_kind discriminates; the
remaining fields are that portal's exact login secrets — e.g.
de_ecorp takes file_number + password; tx_sosdirect takes
client_account + user_id + password; ca_bizfile takes
username + password and optionally entity_pin + totp_seed.
Portals with no login (the public IRS EIN assistant) are not
accepted.
portal_kindstringRequired"de_ecorp""ca_bizfile""ca_edd""ny_gov""tx_sosdirect""tx_webfile""fl_sunbiz""wy_wyobiz""uspto_id_me""fincen_boi"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/portal_credentials" \ -H "Content-Type: application/json" \ -d '{ "entity_id": "ent_8RsLkq2T", "credential": { "portal_kind": "de_ecorp", "file_number": "7423918", "password": "string" } }'const body = JSON.stringify({ "entity_id": "ent_8RsLkq2T", "credential": { "portal_kind": "de_ecorp", "file_number": "7423918", "password": "string" }})fetch("https://api.mattermode.com/v1/portal_credentials", { method: "POST", headers: { "Content-Type": "application/json" }, body})package mainimport ( "fmt" "net/http" "io/ioutil" "strings")func main() { url := "https://api.mattermode.com/v1/portal_credentials" body := strings.NewReader(`{ "entity_id": "ent_8RsLkq2T", "credential": { "portal_kind": "de_ecorp", "file_number": "7423918", "password": "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 = { "entity_id": "ent_8RsLkq2T", "credential": { "portal_kind": "de_ecorp", "file_number": "7423918", "password": "string" }}resp = requests.post( "https://api.mattermode.com/v1/portal_credentials", 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("""{ "entity_id": "ent_8RsLkq2T", "credential": { "portal_kind": "de_ecorp", "file_number": "7423918", "password": "string" }}""");HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder() .uri(URI.create("https://api.mattermode.com/v1/portal_credentials")) .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("""{ "entity_id": "ent_8RsLkq2T", "credential": { "portal_kind": "de_ecorp", "file_number": "7423918", "password": "string" }}""", Encoding.UTF8, "application/json");var client = new HttpClient();var response = await client.PostAsync("https://api.mattermode.com/v1/portal_credentials", body);var responseBody = await response.Content.ReadAsStringAsync();curl --request POST 'https://api.mattermode.com/v1/portal_credentials' \ --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 '{ "entity_id": "ent_8RsLkq2T", "credential": { "portal_kind": "de_ecorp", "file_number": "7423918", "password": "string" }}'const response = await fetch("https://api.mattermode.com/v1/portal_credentials", { 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({ "entity_id": "ent_8RsLkq2T", "credential": { "portal_kind": "de_ecorp", "file_number": "7423918", "password": "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": "pcr_9f2c41d6a8b07e5312fa",
"object": "portal_credential",
"entity_id": "ent_8RsLkq2T",
"portal_kind": "de_ecorp",
"username_hint": "3918",
"status": "active",
"created_at": 1781222400,
"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
}