{ "openapi": "3.0.4", "info": { "title": "ArelHub API", "description": "Customer and integrator endpoints for the ArelHub platform.", "version": "v1" }, "paths": { "/v1/tendlc/brands": { "get": { "tags": [ "10DLC Registration" ], "summary": "List all 10DLC brand registrations for the authenticated account.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenDlcBrand" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenDlcBrand" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenDlcBrand" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "post": { "tags": [ "10DLC Registration" ], "summary": "Register a 10DLC brand for the authenticated account.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterTenDlcBrandRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegisterTenDlcBrandRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegisterTenDlcBrandRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/tendlc/brands/{brandId}": { "get": { "tags": [ "10DLC Registration" ], "summary": "Get a specific 10DLC brand owned by the authenticated account.", "parameters": [ { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "delete": { "tags": [ "10DLC Registration" ], "summary": "Delete a Draft brand that has not been submitted to TCR.", "parameters": [ { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/tendlc/brand": { "get": { "tags": [ "10DLC Registration" ], "summary": "Legacy singular brand lookup — returns the oldest brand for the account.\nPrefer `GET brands` for multi-brand accounts.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "post": { "tags": [ "10DLC Registration" ], "summary": "Register a 10DLC brand for the authenticated account.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterTenDlcBrandRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegisterTenDlcBrandRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegisterTenDlcBrandRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/tendlc/brands/{brandId}/profile": { "put": { "tags": [ "10DLC Registration" ], "summary": "Update TCR profile fields on a Draft or Failed brand before (re)submission.", "parameters": [ { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTenDlcBrandProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateTenDlcBrandProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateTenDlcBrandProfileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/tendlc/brands/{brandId}/identity": { "put": { "tags": [ "10DLC Registration" ], "summary": "Update legal name, EIN, and brand type on a Draft or Failed brand before submission.", "parameters": [ { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTenDlcBrandIdentityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateTenDlcBrandIdentityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateTenDlcBrandIdentityRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/tendlc/brand/profile": { "put": { "tags": [ "10DLC Registration" ], "summary": "Legacy profile update — targets the oldest brand for the account.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTenDlcBrandProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateTenDlcBrandProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateTenDlcBrandProfileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenDlcBrand" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/tendlc/brands/{brandId}/submit": { "post": { "tags": [ "10DLC Registration" ], "summary": "Submit a 10DLC brand to The Campaign Registry (TCR).", "parameters": [ { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/tendlc/brand/submit": { "post": { "tags": [ "10DLC Registration" ], "summary": "Legacy submit — targets the oldest brand for the account.", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/tendlc/brands/{brandId}/resubmit": { "post": { "tags": [ "10DLC Registration" ], "summary": "Resubmit an existing 10DLC brand to TCR after profile changes.", "parameters": [ { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/tendlc/brand/resubmit": { "post": { "tags": [ "10DLC Registration" ], "summary": "Legacy resubmit — targets the oldest brand for the account.", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/tendlc/brands/{brandId}/sync": { "post": { "tags": [ "10DLC Registration" ], "summary": "Force an immediate TCR sync for a specific brand.", "parameters": [ { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/tendlc/brand/sync": { "post": { "tags": [ "10DLC Registration" ], "summary": "Legacy sync — targets the oldest brand for the account.", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/tendlc/campaigns": { "get": { "tags": [ "10DLC Registration" ], "summary": "List all 10DLC campaigns for the authenticated account.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenDlcCampaign" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenDlcCampaign" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TenDlcCampaign" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "post": { "tags": [ "10DLC Registration" ], "summary": "Create a new 10DLC campaign linked to a brand owned by the account.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTenDlcCampaignRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTenDlcCampaignRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTenDlcCampaignRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenDlcCampaign" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenDlcCampaign" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenDlcCampaign" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/tendlc/campaigns/{id}/content": { "put": { "tags": [ "10DLC Registration" ], "summary": "Update content for a draft campaign owned by the authenticated account.\nOptionally submits the updated content to The Campaign Registry.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTenDlcCampaignContentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateTenDlcCampaignContentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateTenDlcCampaignContentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenDlcCampaign" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenDlcCampaign" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenDlcCampaign" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/tendlc/campaigns/{id}/submit": { "post": { "tags": [ "10DLC Registration" ], "summary": "Submit a 10DLC campaign to The Campaign Registry.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/tendlc/campaigns/{id}/sync": { "post": { "tags": [ "10DLC Registration" ], "summary": "Force an immediate TCR sync for a specific campaign.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/me/brands/{brandId}/tcr": { "get": { "tags": [ "10DLC Registration" ], "summary": "Returns sanitized TCR status details for a specific brand owned by the authenticated account.", "parameters": [ { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserBrandTcrStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserBrandTcrStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserBrandTcrStatus" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/me/campaigns/{campaignId}/mno-status": { "get": { "tags": [ "10DLC Registration" ], "summary": "Returns per-MNO status for a specific campaign owned by the authenticated account.", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TcrCampaignMnoStatus" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TcrCampaignMnoStatus" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TcrCampaignMnoStatus" } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/accounts/{accountId}/templates/{templateId}": { "get": { "tags": [ "Account Templates" ], "summary": "Returns the raw `BodyTemplate` and `DefaultVariables` for a template that belongs to\naccountId. Use this to perform variable substitution client-side.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { }, { } ] } }, "/v1/accounts/{accountId}/templates/{templateId}/render": { "post": { "tags": [ "Account Templates" ], "summary": "Render a saved template for the given account with provided variables.\nReturns the rendered body string. Only templates belonging to accountId are accessible.\nVariables omitted from the request fall back to the template's default variables.\nWhen required variables are missing the 400 response lists each one in the ProblemDetails\n`errors` map under the key `variables.{name}`.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenderTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RenderTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RenderTemplateRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { }, { } ] } }, "/v1/account/users": { "get": { "tags": [ "Account Users" ], "summary": "Lists active users belonging to the authenticated user's account.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountUser" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountUser" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountUser" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "post": { "tags": [ "Account Users" ], "summary": "Sends an invitation for a Manager or Associate account user.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InviteAccountUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InviteAccountUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InviteAccountUserRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountUser" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/account/users/{userId}/resend-invitation": { "post": { "tags": [ "Account Users" ], "summary": "Resends a pending invitation to an account user.", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountUser" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/account/invitations/accept": { "post": { "tags": [ "Account Users" ], "summary": "Accepts an invitation and establishes the invited user's password.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptInvitationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AcceptInvitationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AcceptInvitationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountUser" } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/accounts": { "get": { "tags": [ "Accounts" ], "summary": "Returns all accounts visible to the authenticated user.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "post": { "tags": [ "Accounts" ], "summary": "Creates a new account owned by the authenticated user.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAccountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Account" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/accounts/{accountId}": { "get": { "tags": [ "Accounts" ], "summary": "Returns a single account by ID, scoped to the authenticated user.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Account" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "put": { "tags": [ "Accounts" ], "summary": "Updates the name, address, and contact details of an account.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateAccountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Account" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Accounts" ], "summary": "Deletes an account owned by the specified user.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/accounts/{accountId}/address": { "put": { "tags": [ "Accounts" ], "summary": "Update account address", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccountAddressRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAccountAddressRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateAccountAddressRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Account" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/accounts/{accountId}/contact": { "put": { "tags": [ "Accounts" ], "summary": "Update account contact information", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccountContactRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAccountContactRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateAccountContactRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Account" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Account" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/accounts/{accountId}/security-policy": { "get": { "tags": [ "Accounts" ], "summary": "Returns the account's MFA policy and how many users have enrolled.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The policy.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountSecurityPolicyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSecurityPolicyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSecurityPolicyResponse" } } } }, "403": { "description": "Only the account owner (an Admin) can read it.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "put": { "tags": [ "Accounts" ], "summary": "Turns required MFA on or off for the whole account. Needs a step-up. Enabling needs the\nacting Admin to have MFA on first. Users without MFA are taken through enrolment at their\nnext sign-in, and everyone is emailed.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountSecurityPolicyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSecurityPolicyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccountSecurityPolicyRequest" } } } }, "responses": { "200": { "description": "The updated policy.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountSecurityPolicyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSecurityPolicyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSecurityPolicyResponse" } } } }, "403": { "description": "Only the account owner (an Admin) can change it.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "409": { "description": "MFA_NOT_ENABLED: the Admin must turn on MFA first.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/api-keys": { "get": { "tags": [ "API Keys" ], "summary": "List all API keys for the authenticated user's account.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKey" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKey" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKey" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "post": { "tags": [ "API Keys" ], "summary": "Create a new API key for the user's account. The raw key is returned once.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/api-keys/{apiKeyId}": { "get": { "tags": [ "API Keys" ], "summary": "Get a specific API key by ID (must belong to user's account).", "parameters": [ { "name": "apiKeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "delete": { "tags": [ "API Keys" ], "summary": "Soft-delete an API key.", "parameters": [ { "name": "apiKeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/api-keys/{apiKeyId}/rotate": { "post": { "tags": [ "API Keys" ], "summary": "Rotate an API key. Returns the new raw key (shown once).", "parameters": [ { "name": "apiKeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/api-keys/{apiKeyId}/revoke": { "post": { "tags": [ "API Keys" ], "summary": "Revoke an API key.", "parameters": [ { "name": "apiKeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/api-keys/{apiKeyId}/usage": { "get": { "tags": [ "API Keys" ], "summary": "Get usage statistics for an API key.", "parameters": [ { "name": "apiKeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiKeyUsage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyUsage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiKeyUsage" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/api-keys/usage/analytics": { "get": { "tags": [ "API Keys" ], "summary": "Get account-level API usage analytics across all user API keys.", "parameters": [ { "name": "windowHours", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 24 } }, { "name": "topEndpoints", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 5 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ApiKeyUsageAnalytics" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyUsageAnalytics" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiKeyUsageAnalytics" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/health": { "get": { "tags": [ "ArelHub.Api" ], "responses": { "200": { "description": "OK" }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/auth/me": { "get": { "tags": [ "Authentication" ], "summary": "Returns the authenticated caller's resolved identity, account, and permission claims.", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { }, { } ] } }, "/v1/auth/login": { "post": { "tags": [ "Authentication" ], "summary": "Authenticate a user with email and password.\nRecords all login attempts (success and failure) for security tracking.\nEnforces account lockout after 5 failed attempts within 15 minutes.", "requestBody": { "description": "Login credentials (email and password)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserLoginRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserLoginRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserLoginRequest" } } } }, "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized. Credentials rejected, or MFA_REQUIRED: the first factor verified and a code is needed. MFA_REQUIRED carries mfaToken, mfaTokenExpiresAt and mfaMethods. MFA_ENROLLMENT_REQUIRED: the account requires MFA and the user has not set it up; it carries enrollmentToken and enrollmentTokenExpiresAt. No session or refresh cookie is issued for either.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/auth/external-login": { "post": { "tags": [ "Authentication" ], "summary": "Completes external OAuth2 login and issues local ArelHub user tokens.", "requestBody": { "description": "OAuth2 callback data and PKCE verifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalUserLoginRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalUserLoginRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExternalUserLoginRequest" } } } }, "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized. Credentials rejected, or MFA_REQUIRED: the first factor verified and a code is needed. MFA_REQUIRED carries mfaToken, mfaTokenExpiresAt and mfaMethods. MFA_ENROLLMENT_REQUIRED: the account requires MFA and the user has not set it up; it carries enrollmentToken and enrollmentTokenExpiresAt. No session or refresh cookie is issued for either.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/auth/login/mfa": { "post": { "tags": [ "Authentication" ], "summary": "Completes a sign-in that returned `MFA_REQUIRED` by verifying the second factor.", "requestBody": { "description": "The pending-login token, the code and the code type.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserMfaLoginRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserMfaLoginRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserMfaLoginRequest" } } } }, "responses": { "200": { "description": "Signed in.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserMfaLoginResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserMfaLoginResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserMfaLoginResult" } } } }, "400": { "description": "MFA_CHALLENGE_INVALID (missing, expired, used, locked or inactive user) or INVALID_CODE with attemptsRemaining.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "LOCKED: too many wrong codes for this pending sign-in.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized. Credentials rejected, or MFA_REQUIRED: the first factor verified and a code is needed. MFA_REQUIRED carries mfaToken, mfaTokenExpiresAt and mfaMethods. MFA_ENROLLMENT_REQUIRED: the account requires MFA and the user has not set it up; it carries enrollmentToken and enrollmentTokenExpiresAt. No session or refresh cookie is issued for either.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/auth/login/mfa/webauthn/options": { "post": { "tags": [ "Authentication" ], "summary": "Passkey options for the sign-in second step, after `MFA_REQUIRED` listed\n`webauthn` in `mfaMethods`. Pass `options` to\n`navigator.credentials.get`, then call `login/mfa` with method `webauthn`.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebAuthnLoginOptionsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebAuthnLoginOptionsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WebAuthnLoginOptionsRequest" } } } }, "responses": { "200": { "description": "Assertion options and the ceremony id.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebAuthnOptionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebAuthnOptionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebAuthnOptionsResponse" } } } }, "400": { "description": "MFA_CHALLENGE_INVALID.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/auth/login/mfa/enroll/setup": { "post": { "tags": [ "Authentication" ], "summary": "Starts forced MFA enrolment after a sign-in returned `MFA_ENROLLMENT_REQUIRED`\n(the account requires MFA). Returns the authenticator app URI and manual key.\nCalling it again restarts setup.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserMfaEnrollmentSetupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserMfaEnrollmentSetupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserMfaEnrollmentSetupRequest" } } } }, "responses": { "200": { "description": "Provisioning data. The secret is shown here only.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserMfaSetupResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserMfaSetupResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserMfaSetupResponse" } } } }, "400": { "description": "MFA_CHALLENGE_INVALID.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "409": { "description": "MFA_ALREADY_ENABLED.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/auth/login/mfa/enroll/confirm": { "post": { "tags": [ "Authentication" ], "summary": "Confirms forced MFA enrolment with the first authenticator code and completes sign-in.\nThe response carries the recovery codes once.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserMfaEnrollmentConfirmRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserMfaEnrollmentConfirmRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserMfaEnrollmentConfirmRequest" } } } }, "responses": { "200": { "description": "Enrolled and signed in. recoveryCodes is populated once.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserMfaLoginResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserMfaLoginResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserMfaLoginResult" } } } }, "400": { "description": "MFA_CHALLENGE_INVALID, or INVALID_CODE with attemptsRemaining.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "LOCKED: too many wrong codes. Sign in again.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/auth/logout": { "post": { "tags": [ "Authentication" ], "summary": "Logout the current user. Revokes the current token and terminates the session.", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/profile": { "get": { "tags": [ "Authentication" ], "summary": "Get the authenticated user's profile information", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserLoginResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserLoginResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserLoginResult" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "put": { "tags": [ "Authentication" ], "summary": "Update the authenticated user's profile information (first name and last name only)", "requestBody": { "description": "Profile update request with first and last name", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUserProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateUserProfileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserLoginResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserLoginResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserLoginResult" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/request-email-change": { "post": { "tags": [ "Authentication" ], "summary": "Starts a one-time verified change of the authenticated user's login email.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestEmailChangeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RequestEmailChangeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RequestEmailChangeRequest" } } } }, "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/change-password": { "post": { "tags": [ "Authentication" ], "summary": "Change the authenticated user's password.", "requestBody": { "description": "Current and new password values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeUserPasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeUserPasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeUserPasswordRequest" } } } }, "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/forgot-password": { "post": { "tags": [ "Authentication" ], "summary": "Initiates password reset flow by sending a reset link to the user email when the account exists.\nAlways returns success to avoid account enumeration.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForgotUserPasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ForgotUserPasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ForgotUserPasswordRequest" } } } }, "responses": { "200": { "description": "OK" }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/auth/reset-password": { "post": { "tags": [ "Authentication" ], "summary": "Resets password using a signed reset token from the forgot password email.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetUserPasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResetUserPasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResetUserPasswordRequest" } } } }, "responses": { "200": { "description": "OK" }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/billing/subscription": { "get": { "tags": [ "Billing" ], "summary": "Get the authenticated user's active subscription.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountSubscription" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSubscription" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSubscription" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/plans": { "get": { "tags": [ "Billing" ], "summary": "Get available subscription plans.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPlan" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPlan" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPlan" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/events": { "get": { "tags": [ "Billing" ], "summary": "Get billing events for the authenticated account within a date window.", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingEvent" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingEvent" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingEvent" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/outstanding-summary": { "get": { "tags": [ "Billing" ], "summary": "Get the open invoice total and payments applied against it.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OutstandingInvoiceSummary" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OutstandingInvoiceSummary" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OutstandingInvoiceSummary" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/current-cycle": { "get": { "tags": [ "Billing" ], "summary": "Current billing cycle ledger and open (unbilled) balance for the authenticated account.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/BillingCycle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BillingCycle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BillingCycle" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/balance": { "get": { "tags": [ "Billing" ], "summary": "The account balance from the ledger: one signed number (positive is owed, negative is\naccount credit) and its breakdown into unbilled charges, invoiced amounts due and\naccount credit.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountBalance" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountBalance" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountBalance" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/transactions": { "get": { "tags": [ "Billing" ], "summary": "Every charge, payment, refund, credit and adjustment on the account, newest first, with\nthe balance after each. Page with `cursor`, using the previous page's `nextCursor`.", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerTransactionPage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerTransactionPage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerTransactionPage" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/charge-open-balance": { "post": { "tags": [ "Billing" ], "summary": "Invoice unbilled open balance for the active cycle and charge the linked card.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Invoice" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Invoice" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/subscription/change": { "post": { "tags": [ "Billing" ], "summary": "Change the authenticated user's subscription plan.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignPlanRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AssignPlanRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AssignPlanRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountSubscription" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSubscription" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSubscription" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/subscription/cancel": { "post": { "tags": [ "Billing" ], "summary": "Cancel the authenticated user's subscription.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountSubscription" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountSubscription" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSubscription" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/payments/card": { "post": { "tags": [ "Billing" ], "summary": "Pay a one-time amount from the card on file of the authenticated account.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardPaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CardPaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CardPaymentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CardPaymentResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CardPaymentResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CardPaymentResult" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/subscription/preview-change": { "get": { "tags": [ "Billing" ], "summary": "Preview the effects of a plan change for the authenticated user.", "parameters": [ { "name": "newPlanId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlanChangePreview" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlanChangePreview" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlanChangePreview" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/message-costs": { "get": { "tags": [ "Billing" ], "summary": "Get the authenticated account's message cost summary for a date range.\nDefaults to the last 30 days.", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MessageCostSummary" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MessageCostSummary" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MessageCostSummary" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/billing/message-costs/channels": { "get": { "tags": [ "Billing" ], "summary": "Get per-channel cost breakdown for the authenticated account.\nReturns total attempts, carrier cost, and customer charge grouped by channel type.\nDefaults to the last 30 days.", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelCostBreakdown" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelCostBreakdown" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelCostBreakdown" } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/billing/message-costs/detail": { "get": { "tags": [ "Billing" ], "summary": "Get paginated per-message cost detail for the authenticated account.\nDefaults to the last 30 days, 50 per page.", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageCostDetail" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageCostDetail" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageCostDetail" } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/billing/payment-methods": { "get": { "tags": [ "Billing" ], "summary": "Retrieves all saved payment methods for the current user's account.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "post": { "tags": [ "Billing" ], "summary": "Attaches a new payment method to the account (requires step-up authentication).", "requestBody": { "description": "The confirmed payment method id and an optional default flag.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavePaymentMethodRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SavePaymentMethodRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SavePaymentMethodRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/payment-methods/setup-intent": { "post": { "tags": [ "Billing" ], "summary": "Starts adding a new payment method: returns the setup the card form completes.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SetupIntent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SetupIntent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetupIntent" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/payment-methods/{paymentMethodId}/set-default": { "post": { "tags": [ "Billing" ], "summary": "Sets a payment method as the default for the account (requires step-up authentication).", "parameters": [ { "name": "paymentMethodId", "in": "path", "description": "ID of the payment method.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/payment-methods/{paymentMethodId}": { "delete": { "tags": [ "Billing" ], "summary": "Deletes a payment method from the account (requires step-up authentication).", "parameters": [ { "name": "paymentMethodId", "in": "path", "description": "ID of the payment method to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/receipts": { "get": { "tags": [ "Billing" ], "summary": "Returns all receipts for the authenticated account.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Receipt" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Receipt" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Receipt" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/receipts/{receiptId}/download": { "get": { "tags": [ "Billing" ], "summary": "Downloads a receipt owned by the authenticated account as a PDF attachment.\nReceipts that do not exist or belong to another account both return 404.", "parameters": [ { "name": "receiptId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } }, "text/json": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/messages/{messageId}/carrier-events": { "post": { "tags": [ "Carrier Webhooks" ], "summary": "Processes an inbound carrier delivery event for a message.", "parameters": [ { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierEventRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CarrierEventRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CarrierEventRequest" } } } }, "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/webhooks/messages/provider/{providerRegistryKey}/{providerMessageId}/carrier-events": { "post": { "tags": [ "Carrier Webhooks" ], "summary": "Processes an inbound provider-scoped carrier delivery event identified by provider key and message ID.", "parameters": [ { "name": "providerRegistryKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "providerMessageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierEventRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CarrierEventRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CarrierEventRequest" } } } }, "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/accounts/{accountId}/recipient-consent/opt-outs": { "get": { "tags": [ "Channel Consent" ], "summary": "Lists the recipients currently opted out at account level, plus keyword (STOP) and support\nopt-outs of any subaccount. Opt-outs a customer recorded for one subaccount are listed on that\nsubaccount's route.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientOptOut" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientOptOut" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientOptOut" } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/accounts/{accountId}/recipient-consent/preferences": { "get": { "tags": [ "Channel Consent" ], "summary": "Returns per-channel opt-out status for one recipient, as it applies to account-level sends.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "recipient", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RecipientPreferences" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RecipientPreferences" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecipientPreferences" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/accounts/{accountId}/recipient-consent/opt-out": { "post": { "tags": [ "Channel Consent" ], "summary": "Records that a recipient asked to stop receiving messages on a channel. `scope` is\nrequired: `accountLevelOnly` blocks messages sent at account level, `entireAccount`\nblocks the account and every subaccount.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordAccountRecipientOptOutRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordAccountRecipientOptOutRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordAccountRecipientOptOutRequest" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/accounts/{accountId}/recipient-consent/opt-in": { "post": { "tags": [ "Channel Consent" ], "summary": "Records that a recipient who opted out at account level has given new express consent.\nRequires a consent attestation and evidence, which are written to the audit log first. Only\nopt-outs recorded by your team can be lifted: a STOP reply is reversed by the recipient replying\nSTART, and a removal made through support is changed through support.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordRecipientOptInRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordRecipientOptInRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordRecipientOptInRequest" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/accounts/{accountId}/recipient-consent/opt-outs/import": { "post": { "tags": [ "Channel Consent" ], "summary": "Imports opt-outs from a CSV file with the columns `recipient`, `channel` and an optional\n`reason`. `scope` is required and applies to every row. At most 10,000 rows and 5 MB.\nImports only add opt-outs; they never re-subscribe anyone.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "scope", "in": "query", "schema": { "$ref": "#/components/schemas/AccountOptOutScopeChoice" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConsentImportResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConsentImportResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConsentImportResult" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/accounts/{accountId}/recipient-consent/opt-outs/export": { "get": { "tags": [ "Channel Consent" ], "summary": "Exports the account's opt-outs as CSV (at most 10,000 rows; `X-Truncated` says if more exist).", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/accounts/{accountId}/recipient-consent/opt-in-records": { "post": { "tags": [ "Channel Consent" ], "summary": "Stores evidence that a recipient consented to SMS. This does not re-subscribe a recipient who has\nopted out; the `X-Consent-Warning` header says so when that is the case.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordOptInEvidenceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordOptInEvidenceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordOptInEvidenceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OptInEvidence" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OptInEvidence" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OptInEvidence" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "get": { "tags": [ "Channel Consent" ], "summary": "Lists stored consent evidence, newest first. Page with `cursor`.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OptInEvidencePage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OptInEvidencePage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OptInEvidencePage" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/accounts/{accountId}/recipient-consent/opt-in-records/import": { "post": { "tags": [ "Channel Consent" ], "summary": "Imports consent evidence from a CSV with the columns `phone_number`, `opted_in_at`,\n`method` and optional `source` and `consent_language`. At most 10,000 rows and 5 MB.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConsentImportResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConsentImportResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConsentImportResult" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/accounts/{accountId}/recipient-consent/opt-in-records/export": { "get": { "tags": [ "Channel Consent" ], "summary": "Exports stored consent evidence as CSV (at most 10,000 rows).", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/preferences": { "get": { "tags": [ "Channel Consent" ], "summary": "Returns per-channel opt-out status for the authenticated recipient.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelPreferenceStatus" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelPreferenceStatus" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelPreferenceStatus" } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/opt-outs": { "get": { "tags": [ "Channel Consent" ], "summary": "List all opt-out records for a subaccount.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelOptOut" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelOptOut" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelOptOut" } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/opt-out": { "post": { "tags": [ "Channel Consent" ], "summary": "Opt out of a channel for a subaccount (on behalf of a recipient).", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelOptOutRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChannelOptOutRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChannelOptOutRequest" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/opt-in": { "post": { "tags": [ "Channel Consent" ], "summary": "Opt back in to a channel for a subaccount.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelOptInRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChannelOptInRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChannelOptInRequest" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/recipient-consent/opt-outs": { "get": { "tags": [ "Channel Consent" ], "summary": "Lists every recipient opt-out record for the subaccount, including re-subscribed history and\naccount-wide keyword (STOP) opt-outs.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientOptOut" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientOptOut" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientOptOut" } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/recipient-consent/preferences": { "get": { "tags": [ "Channel Consent" ], "summary": "Returns per-channel opt-out status for one recipient of the subaccount.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "recipient", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RecipientPreferences" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RecipientPreferences" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecipientPreferences" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/recipient-consent/opt-out": { "post": { "tags": [ "Channel Consent" ], "summary": "Records that a recipient asked to stop receiving messages on a channel. The opt-out blocks\nthis subaccount's sends and account-level sends to the recipient on that channel.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordRecipientOptOutRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordRecipientOptOutRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordRecipientOptOutRequest" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/recipient-consent/opt-in": { "post": { "tags": [ "Channel Consent" ], "summary": "Records that a recipient who opted out has given new express consent on a channel.\nRequires a consent attestation and evidence, which are written to the audit log first.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordRecipientOptInRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordRecipientOptInRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordRecipientOptInRequest" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/recipient-consent/opt-outs/import": { "post": { "tags": [ "Channel Consent" ], "summary": "Imports opt-outs for the subaccount from a CSV with the columns `recipient`, `channel`\nand an optional `reason`. At most 10,000 rows and 5 MB. Imports only add opt-outs.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConsentImportResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConsentImportResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConsentImportResult" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/recipient-consent/opt-outs/export": { "get": { "tags": [ "Channel Consent" ], "summary": "Exports the opt-outs that apply to the subaccount as CSV (at most 10,000 rows).", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/recipient-consent/opt-in-records": { "post": { "tags": [ "Channel Consent" ], "summary": "Stores evidence that a recipient consented to SMS from this subaccount. This does not re-subscribe\na recipient who has opted out; the `X-Consent-Warning` header says so when that is the case.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordOptInEvidenceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RecordOptInEvidenceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RecordOptInEvidenceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OptInEvidence" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OptInEvidence" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OptInEvidence" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "get": { "tags": [ "Channel Consent" ], "summary": "Lists the subaccount's stored consent evidence, newest first. Page with `cursor`.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OptInEvidencePage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OptInEvidencePage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OptInEvidencePage" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/recipient-consent/opt-in-records/import": { "post": { "tags": [ "Channel Consent" ], "summary": "Imports consent evidence from a CSV with the columns `phone_number`, `opted_in_at`,\n`method` and optional `source` and `consent_language`. At most 10,000 rows and 5 MB.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConsentImportResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConsentImportResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConsentImportResult" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/recipient-consent/opt-in-records/export": { "get": { "tags": [ "Channel Consent" ], "summary": "Exports the subaccount's stored consent evidence as CSV (at most 10,000 rows).", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/routing-policy": { "get": { "tags": [ "Channel Routing" ], "summary": "Get the channel routing policy for a subaccount.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ChannelRoutingPolicy" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChannelRoutingPolicy" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChannelRoutingPolicy" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "put": { "tags": [ "Channel Routing" ], "summary": "Create or update the channel routing policy for a subaccount.\nSets the preferred channel type and ordered fallback chain used at runtime dispatch.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertChannelRoutingPolicyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertChannelRoutingPolicyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertChannelRoutingPolicyRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ChannelRoutingPolicy" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChannelRoutingPolicy" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChannelRoutingPolicy" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/routing-policy/preview": { "get": { "tags": [ "Channel Routing" ], "summary": "Preview the effective channel route that would be resolved for a given channel type and subaccount.\nReturns the ordered list of channels (primary + fallbacks) that dispatch would attempt.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "requestedChannelType", "in": "query", "schema": { "$ref": "#/components/schemas/ChannelTypeEntity" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ChannelRoutePreview" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChannelRoutePreview" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChannelRoutePreview" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/email-otp/issue": { "post": { "tags": [ "Email OTP" ], "summary": "Issue a new email OTP challenge for the authenticated user.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IssueRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IssueRequest" } } } }, "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/email-otp/verify": { "post": { "tags": [ "Email OTP" ], "summary": "Verify an email OTP challenge for the authenticated user.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VerifyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VerifyRequest" } } } }, "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/invoices": { "get": { "tags": [ "Invoices" ], "summary": "Lists all invoices for the authenticated account.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/invoices/{invoiceId}": { "get": { "tags": [ "Invoices" ], "summary": "Returns a single invoice by ID, verifying it belongs to the authenticated account.", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Invoice" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Invoice" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/invoices/{invoiceId}/lines": { "get": { "tags": [ "Invoices" ], "summary": "Returns the charges on an invoice, in invoice order. Their amounts add up to the invoice\nsubtotal.", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLine" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLine" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLine" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/invoices/{invoiceId}/download": { "get": { "tags": [ "Invoices" ], "summary": "Generates and downloads the specified invoice as a PDF attachment.", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/{userId}/login-history": { "get": { "tags": [ "Login History" ], "summary": "Get paginated login history for the authenticated user", "parameters": [ { "name": "userId", "in": "path", "description": "User ID to fetch history for", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageNumber", "in": "query", "description": "Page number for pagination (default: 1)", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Number of items per page (default: 50)", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserLoginHistoryPagedResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserLoginHistoryPagedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserLoginHistoryPagedResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/{userId}/login-history/failed": { "get": { "tags": [ "Login History" ], "summary": "Get failed login attempts only", "parameters": [ { "name": "userId", "in": "path", "description": "User ID to fetch failed attempts for", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageNumber", "in": "query", "description": "Page number for pagination (default: 1)", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Number of items per page (default: 50)", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserLoginHistoryPagedResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserLoginHistoryPagedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserLoginHistoryPagedResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/{userId}/login-history/successful": { "get": { "tags": [ "Login History" ], "summary": "Get successful login attempts only", "parameters": [ { "name": "userId", "in": "path", "description": "User ID to fetch successful attempts for", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageNumber", "in": "query", "description": "Page number for pagination (default: 1)", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Number of items per page (default: 50)", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserLoginHistoryPagedResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserLoginHistoryPagedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserLoginHistoryPagedResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/{userId}/login-history/stats": { "get": { "tags": [ "Login History" ], "summary": "Get login history statistics for the authenticated user", "parameters": [ { "name": "userId", "in": "path", "description": "User ID to fetch statistics for", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LoginStatistics" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoginStatistics" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginStatistics" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/{userId}/activity-timeline": { "get": { "tags": [ "Login History" ], "summary": "Get a merged account activity timeline containing audit events and login events.", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 25 } }, { "name": "lookbackDays", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 30 } }, { "name": "searchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "activityType", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountActivityTimeline" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountActivityTimeline" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountActivityTimeline" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/{userId}/login-history/by-date-range": { "get": { "tags": [ "Login History" ], "summary": "Get login history filtered by date range", "parameters": [ { "name": "userId", "in": "path", "description": "User ID to fetch history for", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "startDate", "in": "query", "description": "Start of date range (inclusive)", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "End of date range (exclusive)", "schema": { "type": "string", "format": "date-time" } }, { "name": "pageNumber", "in": "query", "description": "Page number for pagination (default: 1)", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Number of items per page (default: 50)", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserLoginHistoryPagedResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserLoginHistoryPagedResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserLoginHistoryPagedResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/{userId}/login-history/is-locked": { "get": { "tags": [ "Login History" ], "summary": "Check if account is locked due to failed login attempts", "parameters": [ { "name": "userId", "in": "path", "description": "User ID to check lockout status for", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/accounts/{accountId}/inbound-messages": { "get": { "tags": [ "Messages" ], "summary": "Lists the replies an account has received, newest first. Page with `cursor`, using the\nprevious page's `nextCursor`.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InboundMessagePage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InboundMessagePage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InboundMessagePage" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { }, { } ] } }, "/v1/subaccounts/{subaccountId}/inbound-messages": { "get": { "tags": [ "Messages" ], "summary": "Lists the replies a subaccount has received, newest first. Page with `cursor`, using\nthe previous page's `nextCursor`.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/InboundMessagePage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InboundMessagePage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InboundMessagePage" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { }, { } ] } }, "/v1/accounts/{accountId}/messages/{messageId}/replies": { "get": { "tags": [ "Messages" ], "summary": "Lists the replies linked to one message, oldest first.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InboundMessage" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InboundMessage" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InboundMessage" } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { }, { } ] } }, "/v1/subaccounts/{subaccountId}/messages/{messageId}/replies": { "get": { "tags": [ "Messages" ], "summary": "Lists the replies linked to one subaccount message, oldest first.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InboundMessage" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InboundMessage" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InboundMessage" } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { }, { } ] } }, "/v1/accounts/{accountId}/messages/{messageId}/risk": { "get": { "tags": [ "Messages" ], "summary": "Returns the latest risk decision for a message, with a customer-safe explanation.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MessageRiskResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MessageRiskResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MessageRiskResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/accounts/{accountId}/messages": { "post": { "tags": [ "Messages" ], "summary": "Submits a new message for dispatch under the specified account.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMessageRequest" }, "examples": { "sms-transactional": { "summary": "SMS transactional", "description": "Simple SMS dispatch with E.164 destination.", "value": { "channel": "SMS", "destination": "+15551234567", "body": "Your OTP is 123456", "messageType": "Transactional", "actor": "user-api" } }, "sms-message-template": { "summary": "SMS message template", "description": "User-owned message template. Body is rendered from the template and variables; ChannelTemplate selection remains server-side.", "value": { "channel": "SMS", "destination": "+15551234567", "body": "", "messageType": "Transactional", "actor": "user-api", "templateId": "11111111-1111-1111-1111-111111111111", "templateVariables": { "name": "Ada", "code": "123456" } } }, "email-transactional": { "summary": "Email transactional", "description": "Email message using the same unified submit contract.", "value": { "channel": "Email", "destination": "ops@arelhub.com", "body": "Daily report is ready.", "messageType": "Transactional", "actor": "user-api" } }, "whatsapp-template": { "summary": "WhatsApp", "description": "WhatsApp send request. Template resolution occurs server-side via approved channel templates.", "value": { "channel": "WhatsApp", "destination": "+15557654321", "body": "Order #9421 shipped", "messageType": "Transactional", "actor": "user-api" } }, "slack-internal": { "summary": "Slack internal", "description": "Slack channel dispatch through the same lifecycle path.", "value": { "channel": "Slack", "destination": "#alerts", "body": "Payment webhook backlog exceeded threshold", "messageType": "System", "actor": "staff-api" } }, "rcs-transactional": { "summary": "RCS transactional", "description": "RCS dispatch through the unified submit contract using an E.164 destination.", "value": { "channel": "RCS", "destination": "+15559876543", "body": "Your verification code is 842991", "messageType": "Transactional", "actor": "user-api" } }, "inapppush-segment": { "summary": "In-App Push segment", "description": "Firebase segment fan-out using topic targets.", "value": { "channel": "InAppPush", "destination": "", "body": "Scheduled maintenance starts in 10 minutes.", "messageType": "System", "actor": "system-worker", "pushTopics": [ "segment:oncall", "segment:priority-tenants" ], "pushUserIds": [ "user-8f5e1f2a" ] } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMessageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMessageRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Message" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Message" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { }, { } ] }, "get": { "tags": [ "Messages" ], "summary": "Lists messages for an account with optional server-side filtering.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Direction", "in": "query", "schema": { "type": "string" } }, { "name": "MessageState", "in": "query", "schema": { "$ref": "#/components/schemas/MessageStateEntity" } }, { "name": "ChannelType", "in": "query", "schema": { "$ref": "#/components/schemas/ChannelTypeEntity" } }, { "name": "Destination", "in": "query", "schema": { "type": "string" } }, { "name": "AccountName", "in": "query", "schema": { "type": "string" } }, { "name": "SubaccountName", "in": "query", "schema": { "type": "string" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "CreatedFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "CreatedTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { }, { } ] } }, "/v1/accounts/{accountId}/messages/{messageId}": { "get": { "tags": [ "Messages" ], "summary": "Returns a single message by ID for the specified account.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { }, { } ] } }, "/v1/accounts/{accountId}/messages/{messageId}/cancel": { "post": { "tags": [ "Messages" ], "summary": "Cancels a message that is still scheduled. A message in any other state cannot be canceled.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Message" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Message" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { }, { } ] } }, "/v1/messages/segments/preview": { "post": { "tags": [ "Messages" ], "summary": "Calculates segment count, encoding, and estimated cost for a message body without sending it.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SegmentPreviewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SegmentPreviewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SegmentPreviewRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SegmentPreviewResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SegmentPreviewResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SegmentPreviewResponse" } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/subaccounts/{subaccountId}/messages": { "post": { "tags": [ "Messages" ], "summary": "Submits a new message for dispatch under the specified subaccount.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMessageRequest" }, "examples": { "sms-transactional": { "summary": "SMS transactional", "description": "Simple SMS dispatch with E.164 destination.", "value": { "channel": "SMS", "destination": "+15551234567", "body": "Your OTP is 123456", "messageType": "Transactional", "actor": "user-api" } }, "sms-message-template": { "summary": "SMS message template", "description": "User-owned message template. Body is rendered from the template and variables; ChannelTemplate selection remains server-side.", "value": { "channel": "SMS", "destination": "+15551234567", "body": "", "messageType": "Transactional", "actor": "user-api", "templateId": "11111111-1111-1111-1111-111111111111", "templateVariables": { "name": "Ada", "code": "123456" } } }, "email-transactional": { "summary": "Email transactional", "description": "Email message using the same unified submit contract.", "value": { "channel": "Email", "destination": "ops@arelhub.com", "body": "Daily report is ready.", "messageType": "Transactional", "actor": "user-api" } }, "whatsapp-template": { "summary": "WhatsApp", "description": "WhatsApp send request. Template resolution occurs server-side via approved channel templates.", "value": { "channel": "WhatsApp", "destination": "+15557654321", "body": "Order #9421 shipped", "messageType": "Transactional", "actor": "user-api" } }, "slack-internal": { "summary": "Slack internal", "description": "Slack channel dispatch through the same lifecycle path.", "value": { "channel": "Slack", "destination": "#alerts", "body": "Payment webhook backlog exceeded threshold", "messageType": "System", "actor": "staff-api" } }, "rcs-transactional": { "summary": "RCS transactional", "description": "RCS dispatch through the unified submit contract using an E.164 destination.", "value": { "channel": "RCS", "destination": "+15559876543", "body": "Your verification code is 842991", "messageType": "Transactional", "actor": "user-api" } }, "inapppush-segment": { "summary": "In-App Push segment", "description": "Firebase segment fan-out using topic targets.", "value": { "channel": "InAppPush", "destination": "", "body": "Scheduled maintenance starts in 10 minutes.", "messageType": "System", "actor": "system-worker", "pushTopics": [ "segment:oncall", "segment:priority-tenants" ], "pushUserIds": [ "user-8f5e1f2a" ] } } } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMessageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMessageRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Message" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Message" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { }, { } ] }, "get": { "tags": [ "Messages" ], "summary": "Lists messages for a subaccount with optional server-side filtering.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Direction", "in": "query", "schema": { "type": "string" } }, { "name": "MessageState", "in": "query", "schema": { "$ref": "#/components/schemas/MessageStateEntity" } }, { "name": "ChannelType", "in": "query", "schema": { "$ref": "#/components/schemas/ChannelTypeEntity" } }, { "name": "Destination", "in": "query", "schema": { "type": "string" } }, { "name": "AccountName", "in": "query", "schema": { "type": "string" } }, { "name": "SubaccountName", "in": "query", "schema": { "type": "string" } }, { "name": "IncludeDeleted", "in": "query", "schema": { "type": "boolean" } }, { "name": "CreatedFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "CreatedTo", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { }, { } ] } }, "/v1/subaccounts/{subaccountId}/messages/{messageId}": { "get": { "tags": [ "Messages" ], "summary": "Returns a single message by ID for the specified subaccount.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { }, { } ] } }, "/v1/subaccounts/{subaccountId}/messages/{messageId}/cancel": { "post": { "tags": [ "Messages" ], "summary": "Cancels a message that is still scheduled. A message in any other state cannot be canceled.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Message" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Message" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { }, { } ] } }, "/v1/auth/mfa": { "get": { "tags": [ "Multi-Factor Authentication" ], "summary": "Returns whether MFA is enabled for the signed-in user.", "responses": { "200": { "description": "Current MFA state.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserMfaStatusResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserMfaStatusResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserMfaStatusResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Multi-Factor Authentication" ], "summary": "Disables MFA. Requires an authenticator code or an unused recovery code.", "requestBody": { "description": "The code and its type.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserMfaDisableRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserMfaDisableRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserMfaDisableRequest" } } } }, "responses": { "204": { "description": "MFA disabled." }, "400": { "description": "INVALID_CODE.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "409": { "description": "MFA_NOT_ENABLED.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/mfa/totp/setup": { "post": { "tags": [ "Multi-Factor Authentication" ], "summary": "Starts authenticator enrolment and returns the provisioning URI and manual key.", "responses": { "200": { "description": "Provisioning data. The secret is shown here only.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserMfaSetupResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserMfaSetupResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserMfaSetupResponse" } } } }, "409": { "description": "MFA_ALREADY_ENABLED.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/mfa/totp/confirm": { "post": { "tags": [ "Multi-Factor Authentication" ], "summary": "Verifies the first authenticator code, activates MFA and returns the recovery codes (shown once).\nEvery other session of the user is signed out; the current session keeps working.", "requestBody": { "description": "The current authenticator code.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserMfaCodeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserMfaCodeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserMfaCodeRequest" } } } }, "responses": { "200": { "description": "MFA enabled; recovery codes returned once.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserMfaRecoveryCodesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserMfaRecoveryCodesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserMfaRecoveryCodesResponse" } } } }, "400": { "description": "INVALID_CODE.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "409": { "description": "MFA_NOT_ENABLED (no setup in progress) or MFA_ALREADY_ENABLED.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/mfa/recovery-codes": { "post": { "tags": [ "Multi-Factor Authentication" ], "summary": "Replaces the recovery codes. Requires the current authenticator code.", "requestBody": { "description": "The current authenticator code.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserMfaCodeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserMfaCodeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserMfaCodeRequest" } } } }, "responses": { "200": { "description": "New recovery codes, shown once. The old set no longer works.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserMfaRecoveryCodesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserMfaRecoveryCodesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserMfaRecoveryCodesResponse" } } } }, "400": { "description": "INVALID_CODE.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "409": { "description": "MFA_NOT_ENABLED.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/mfa/step-up": { "post": { "tags": [ "Multi-Factor Authentication" ], "summary": "Verifies an authenticator code (`method: \"totp\"`) or a passkey assertion\n(`method: \"webauthn\"`, after `step-up/webauthn/options`) and issues a single-use\nstep-up token.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaStepUpRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MfaStepUpRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MfaStepUpRequest" } } } }, "responses": { "200": { "description": "Step-up token.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MfaStepUpResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MfaStepUpResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MfaStepUpResponse" } } } }, "400": { "description": "INVALID_CODE (recovery codes are not accepted).", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "409": { "description": "MFA_NOT_ENABLED. Use the email-code step-up instead.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "LOCKED: too many wrong codes. See retryAfterSeconds.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/mfa/webauthn": { "get": { "tags": [ "Multi-Factor Authentication" ], "summary": "Lists the user's passkeys. Key material is never returned.", "responses": { "200": { "description": "The passkeys (empty when passkeys are off).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PasskeyListResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PasskeyListResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PasskeyListResponse" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/mfa/webauthn/register/options": { "post": { "tags": [ "Multi-Factor Authentication" ], "summary": "Starts registering a passkey. Needs a step-up (`MfaManage`) and MFA turned on.\nPass `options` to `navigator.credentials.create`.", "responses": { "200": { "description": "Registration options and the ceremony id.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebAuthnOptionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebAuthnOptionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebAuthnOptionsResponse" } } } }, "409": { "description": "MFA_NOT_ENABLED: turn on the authenticator app first.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/mfa/webauthn/register/complete": { "post": { "tags": [ "Multi-Factor Authentication" ], "summary": "Finishes registering a passkey with the browser's response.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebAuthnRegisterCompleteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebAuthnRegisterCompleteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WebAuthnRegisterCompleteRequest" } } } }, "responses": { "200": { "description": "The new passkey.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PasskeyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PasskeyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PasskeyResponse" } } } }, "400": { "description": "WEBAUTHN_VERIFICATION_FAILED or MFA_CHALLENGE_INVALID.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/mfa/step-up/webauthn/options": { "post": { "tags": [ "Multi-Factor Authentication" ], "summary": "Starts a passkey assertion for a step-up. Pass `options` to `navigator.credentials.get`.", "responses": { "200": { "description": "Assertion options and the ceremony id.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebAuthnOptionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebAuthnOptionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebAuthnOptionsResponse" } } } }, "404": { "description": "NOT_FOUND: the user has no passkey.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/mfa/webauthn/{id}": { "patch": { "tags": [ "Multi-Factor Authentication" ], "summary": "Renames a passkey.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebAuthnRenameRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebAuthnRenameRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WebAuthnRenameRequest" } } } }, "responses": { "204": { "description": "Renamed." }, "404": { "description": "NOT_FOUND.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Multi-Factor Authentication" ], "summary": "Removes a passkey. Needs a step-up (`MfaManage`). The owner is emailed.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "Removed." }, "404": { "description": "NOT_FOUND.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/preferences/notifications": { "get": { "tags": [ "Notification Preferences" ], "summary": "Returns the notification preferences for the authenticated user.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserNotificationPreferences" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserNotificationPreferences" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserNotificationPreferences" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "put": { "tags": [ "Notification Preferences" ], "summary": "Updates the notification preferences for the authenticated user.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserNotificationPreferences" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserNotificationPreferences" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserNotificationPreferences" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserNotificationPreferences" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserNotificationPreferences" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserNotificationPreferences" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/number-pools": { "get": { "tags": [ "Number Pools" ], "summary": "List all number pools for the authenticated account.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NumberPool" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NumberPool" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NumberPool" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "post": { "tags": [ "Number Pools" ], "summary": "Create a new number pool.", "description": "Each scope (account-wide or a single subaccount) can have at most one active pool.\nCreating a second active pool for the same scope returns 409 Conflict.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNumberPoolRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateNumberPoolRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateNumberPoolRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NumberPool" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NumberPool" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NumberPool" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/number-pools/{id}/numbers/{phoneNumberId}": { "post": { "tags": [ "Number Pools" ], "summary": "Add a phone number to a pool.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "phoneNumberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Number Pools" ], "summary": "Remove a phone number from a pool.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "phoneNumberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/number-pools/{id}": { "delete": { "tags": [ "Number Pools" ], "summary": "Delete a number pool. All numbers in the pool will be unassigned first.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/authorize": { "post": { "tags": [ "OAuth2 Authentication" ], "summary": "Gets authorization URL for OAuth2 provider.\nClient should redirect user to this URL for provider login.", "requestBody": { "description": "Provider ID and redirect URI", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizeProviderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuthorizeProviderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AuthorizeProviderRequest" } } } }, "responses": { "200": { "description": "Authorization URL generated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorizeProviderResponse" } } } }, "400": { "description": "Invalid provider or request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Provider not found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/auth/callback": { "post": { "tags": [ "OAuth2 Authentication" ], "summary": "Handles OAuth2 provider callback.\nCalled by provider after user authorizes. Exchanges code for tokens and user info.", "requestBody": { "description": "Callback data from OAuth2 provider", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuth2CallbackRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuth2CallbackRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OAuth2CallbackRequest" } } } }, "responses": { "200": { "description": "Callback handled successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuth2CallbackResponse" } } } }, "400": { "description": "Invalid callback or user auth failed", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/auth/link": { "post": { "tags": [ "OAuth2 Authentication" ], "summary": "Links an external provider to authenticated user's account.\nAllows multi-provider authentication for same user.", "requestBody": { "description": "Provider link request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkProviderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LinkProviderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LinkProviderRequest" } } } }, "responses": { "200": { "description": "Provider linked successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalIdentityResponse" } } } }, "400": { "description": "Invalid request or duplicate provider", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "User not authenticated", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Provider not found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/unlink": { "post": { "tags": [ "OAuth2 Authentication" ], "summary": "Unlinks an external provider from authenticated user's account.", "requestBody": { "description": "Provider unlink request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnlinkProviderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UnlinkProviderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UnlinkProviderRequest" } } } }, "responses": { "204": { "description": "Provider unlinked successfully" }, "400": { "description": "Invalid request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "User not authenticated", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Identity not found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "409": { "description": "The identity is the user's only sign-in method", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/identities": { "get": { "tags": [ "OAuth2 Authentication" ], "summary": "Gets all external provider identities linked to authenticated user.", "responses": { "200": { "description": "Identities retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserIdentitiesResponse" } } } }, "401": { "description": "User not authenticated", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/identities/primary": { "get": { "tags": [ "OAuth2 Authentication" ], "summary": "Gets the user's primary (preferred) authentication method.", "responses": { "200": { "description": "Primary identity retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalIdentityResponse" } } } }, "401": { "description": "User not authenticated", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "No primary identity set", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "post": { "tags": [ "OAuth2 Authentication" ], "summary": "Sets an external identity as the user's primary authentication method.", "requestBody": { "description": "Identity to set as primary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPrimaryIdentityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetPrimaryIdentityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetPrimaryIdentityRequest" } } } }, "responses": { "204": { "description": "Primary identity set successfully" }, "400": { "description": "Invalid request or unlinked identity", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "User not authenticated", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Identity not found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/providers": { "get": { "tags": [ "OAuth2 Authentication" ], "summary": "Gets all OAuth2 providers.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalAuthProviderResponse" } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "post": { "tags": [ "OAuth2 Authentication" ], "summary": "Creates a new OAuth2 provider.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProviderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProviderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateProviderRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAuthProviderResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/providers/public": { "get": { "tags": [ "OAuth2 Authentication" ], "summary": "Gets active OAuth2 providers for public login discovery.\nReturns only non-sensitive fields needed by client login UIs.", "parameters": [ { "name": "providerType", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicExternalAuthProviderResponse" } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/auth/providers/{providerId}": { "put": { "tags": [ "OAuth2 Authentication" ], "summary": "Updates an OAuth2 provider.", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProviderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateProviderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateProviderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAuthProviderResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "delete": { "tags": [ "OAuth2 Authentication" ], "summary": "Deletes an OAuth2 provider.", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/providers/{providerId}/activate": { "post": { "tags": [ "OAuth2 Authentication" ], "summary": "Activates an OAuth2 provider.", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/providers/{providerId}/deactivate": { "post": { "tags": [ "OAuth2 Authentication" ], "summary": "Deactivates an OAuth2 provider.", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/kyc-documents": { "get": { "tags": [ "Onboarding" ], "summary": "Lists the authenticated owner's submitted KYC documents.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KycDocument" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KycDocument" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KycDocument" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "post": { "tags": [ "Onboarding" ], "summary": "Submits a PDF, JPEG, or PNG KYC document for staff review.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "documentType": { "type": "string" }, "file": { "type": "string", "format": "binary" } } }, "encoding": { "documentType": { "style": "form" }, "file": { "style": "form" } } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KycDocument" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KycDocument" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KycDocument" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/kyc-documents/{documentId}/download": { "get": { "tags": [ "Onboarding" ], "summary": "Downloads one of the authenticated owner's submitted documents.", "parameters": [ { "name": "documentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/onboarding": { "get": { "tags": [ "Onboarding" ], "summary": "Returns the onboarding status and checklist for the authenticated user's account.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountOnboardingStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountOnboardingStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountOnboardingStatus" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/onboarding/resend-email-verification": { "post": { "tags": [ "Onboarding" ], "summary": "Resends the email confirmation link to the authenticated user's registered address.", "responses": { "200": { "description": "OK" }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/webhooks/config": { "get": { "tags": [ "Payment Webhooks" ], "summary": "Get webhook configuration for the authenticated account", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookConfig" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookConfig" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookConfig" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "post": { "tags": [ "Payment Webhooks" ], "summary": "Configure payment webhook URL and generate secret", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigureWebhookRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConfigureWebhookRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ConfigureWebhookRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookConfig" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookConfig" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookConfig" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/webhooks/enable": { "post": { "tags": [ "Payment Webhooks" ], "summary": "Enable payment webhooks", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/webhooks/disable": { "post": { "tags": [ "Payment Webhooks" ], "summary": "Disable payment webhooks", "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/billing/webhooks/regenerate-secret": { "post": { "tags": [ "Payment Webhooks" ], "summary": "Regenerate webhook secret", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookSecret" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSecret" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookSecret" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/payout-account/onboard": { "post": { "tags": [ "Payout Account" ], "summary": "Create the Account's payout account and get its onboarding URL", "description": "This endpoint:\n1. Creates a payout account for the Account\n2. Returns an onboarding URL for the Account admin to complete verification\n3. Once verified, the Account can charge their Subaccounts", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OnboardingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OnboardingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OnboardingResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/payout-account/status": { "get": { "tags": [ "Payout Account" ], "summary": "Check payout account onboarding status", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OnboardingStatusResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OnboardingStatusResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OnboardingStatusResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/payout-account/update-details": { "post": { "tags": [ "Payout Account" ], "summary": "Create a hosted session for updating the payout account details.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PayoutAccountLinkResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PayoutAccountLinkResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PayoutAccountLinkResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/payout-account/express-dashboard": { "post": { "tags": [ "Payout Account" ], "summary": "Create a short-lived login link to the payout account dashboard.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PayoutAccountLinkResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PayoutAccountLinkResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PayoutAccountLinkResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/phone-numbers/search": { "get": { "tags": [ "Phone Numbers" ], "summary": "Search available phone numbers.", "parameters": [ { "name": "areaCode", "in": "query", "schema": { "type": "string" } }, { "name": "regionCode", "in": "query", "schema": { "type": "string" } }, { "name": "countryCode", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "$ref": "#/components/schemas/PhoneNumberTypeEntity" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableNumber" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableNumber" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableNumber" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "502": { "description": "Bad Gateway", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/phone-numbers/purchase": { "post": { "tags": [ "Phone Numbers" ], "summary": "Purchase a phone number and provision it to the account.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchasePhoneNumberRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchasePhoneNumberRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PurchasePhoneNumberRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProvisionedPhoneNumber" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProvisionedPhoneNumber" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProvisionedPhoneNumber" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/phone-numbers": { "get": { "tags": [ "Phone Numbers" ], "summary": "List all provisioned numbers for the authenticated account.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProvisionedPhoneNumber" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProvisionedPhoneNumber" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProvisionedPhoneNumber" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/phone-numbers/{id}/assign": { "post": { "tags": [ "Phone Numbers" ], "summary": "Assign a phone number to a subaccount.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignPhoneNumberRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AssignPhoneNumberRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AssignPhoneNumberRequest" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/phone-numbers/{id}/unassign": { "post": { "tags": [ "Phone Numbers" ], "summary": "Remove subaccount assignment from a phone number.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/phone-numbers/{id}/set-default": { "post": { "tags": [ "Phone Numbers" ], "summary": "Set a phone number as the default for account or subaccount.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/phone-numbers/{id}": { "delete": { "tags": [ "Phone Numbers" ], "summary": "Release (delete) a phone number. This action is irreversible.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/plans": { "get": { "tags": [ "Plans" ], "summary": "Get active subscription plans. Anonymous — used by the public pricing page.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPlan" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPlan" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionPlan" } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/privacy/export": { "post": { "tags": [ "Privacy" ], "summary": "Request a data export (DSAR - Data Subject Access Request)\nUser can download all their personal data within 30 days (GDPR requirement)", "description": "POST /v1/privacy/export\nReturns: 201 Created with request details", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DataSubjectRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DataSubjectRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DataSubjectRequest" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/privacy/erasure": { "post": { "tags": [ "Privacy" ], "summary": "Request account erasure/anonymization (Right to be Forgotten - GDPR Article 17)\nUser's personal data will be anonymized while preserving billing/audit records", "description": "POST /v1/privacy/erasure\nReturns: 201 Created with request details", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DataSubjectRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DataSubjectRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DataSubjectRequest" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/privacy/requests/{requestId}": { "get": { "tags": [ "Privacy" ], "summary": "Get a specific privacy request by ID\nUser can only access their own requests", "description": "GET /v1/privacy/requests/{requestId}\nReturns: 200 OK with request details, or 404 Not Found", "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DataSubjectRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DataSubjectRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DataSubjectRequest" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/privacy/requests": { "get": { "tags": [ "Privacy" ], "summary": "Get all privacy requests for the current user", "description": "GET /v1/privacy/requests\nReturns: 200 OK with list of user's requests", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataSubjectRequest" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataSubjectRequest" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DataSubjectRequest" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/privacy/requests/{requestId}/download": { "get": { "tags": [ "Privacy" ], "summary": "Download data export file\nUser can only download their own exports, and only within 7 days of generation", "description": "GET /v1/privacy/requests/{requestId}/download\nReturns: 200 OK with JSON export file, or 404/410 if expired", "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/privacy/consent/{category}": { "post": { "tags": [ "Privacy" ], "summary": "Grant consent for a data processing category", "description": "POST /v1/privacy/consent/{category}\nCategories: Marketing, Analytics, Profiling, ThirdPartySharing\nReturns: 201 Created with consent record", "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ConsentCategoryEntity" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConsentRecord" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConsentRecord" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConsentRecord" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Privacy" ], "summary": "Revoke consent for a data processing category\nUser has the right to withdraw consent at any time (GDPR Article 7.3)", "description": "DELETE /v1/privacy/consent/{category}\nReturns: 204 No Content on success", "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ConsentCategoryEntity" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "get": { "tags": [ "Privacy" ], "summary": "Get current (most recent) consent status for a category", "description": "GET /v1/privacy/consent/{category}\nReturns: 200 OK with consent record, or 404 if no consent exists", "parameters": [ { "name": "category", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ConsentCategoryEntity" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConsentRecord" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConsentRecord" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConsentRecord" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/privacy/consents": { "get": { "tags": [ "Privacy" ], "summary": "Get all consent records for the current user (full audit trail)", "description": "GET /v1/privacy/consents\nReturns: 200 OK with list of all consent records", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConsentRecord" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConsentRecord" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConsentRecord" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/provider-discovery/discover": { "post": { "tags": [ "Provider Discovery" ], "summary": "Discovers a provider by email domain.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoverProviderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DiscoverProviderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DiscoverProviderRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoverProviderResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/openapi/public.json": { "get": { "tags": [ "PublicOpenApi" ], "summary": "Returns the public OpenAPI document as JSON.", "responses": { "200": { "description": "OK" }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/openapi/public.yaml": { "get": { "tags": [ "PublicOpenApi" ], "summary": "Returns the public OpenAPI document as YAML.", "responses": { "200": { "description": "OK" }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/quota": { "get": { "tags": [ "Quota" ], "summary": "Get the authenticated user's account quota and current usage.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccountQuota" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccountQuota" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountQuota" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/quota/subaccounts": { "get": { "tags": [ "Quota" ], "summary": "Get all subaccount quotas for the authenticated user's account.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubaccountQuota" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubaccountQuota" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubaccountQuota" } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/quota/subaccounts/{subaccountId}": { "get": { "tags": [ "Quota" ], "summary": "Get quota and usage for a specific subaccount owned by the authenticated user.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SubaccountQuota" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubaccountQuota" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubaccountQuota" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "put": { "tags": [ "Quota" ], "summary": "Set or update quota limits for a subaccount owned by the authenticated user.\nUse 0 to set a limit to unlimited. Omit (null) to keep current value.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateQuotaRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateQuotaRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateQuotaRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SubaccountQuota" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubaccountQuota" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubaccountQuota" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/realtime-metrics": { "get": { "tags": [ "Realtime Metrics" ], "summary": "Returns the current metrics snapshot for all of the caller's accounts.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RealtimeMetrics" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RealtimeMetrics" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RealtimeMetrics" } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/realtime-metrics/account/{accountId}": { "get": { "tags": [ "Realtime Metrics" ], "summary": "Returns the current metrics snapshot for a specific account.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RealtimeMetrics" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RealtimeMetrics" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RealtimeMetrics" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/realtime-metrics/subaccount/{subaccountId}": { "get": { "tags": [ "Realtime Metrics" ], "summary": "Returns the current metrics snapshot for a specific subaccount.", "parameters": [ { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RealtimeMetrics" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RealtimeMetrics" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RealtimeMetrics" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/realtime-metrics/history": { "get": { "tags": [ "Realtime Metrics" ], "summary": "Returns historical metrics snapshots with optional account/subaccount and time-range filters.", "parameters": [ { "name": "accountId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "subaccountId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "fromUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "toUtc", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RealtimeMetrics" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RealtimeMetrics" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RealtimeMetrics" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/realtime-metrics/health": { "get": { "tags": [ "Realtime Metrics" ], "summary": "Returns the health status of the real-time metrics system.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RealtimeMetricsHealth" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RealtimeMetricsHealth" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RealtimeMetricsHealth" } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/register/payment-config": { "get": { "tags": [ "Registration" ], "summary": "Returns the public key the payment form needs during signup.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicRegistrationPaymentConfig" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PublicRegistrationPaymentConfig" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublicRegistrationPaymentConfig" } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/register/payment-diagnostics": { "get": { "tags": [ "Registration" ], "summary": "Retrieves payment key diagnostics for the local development environment.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicRegistrationPaymentDiagnostics" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PublicRegistrationPaymentDiagnostics" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublicRegistrationPaymentDiagnostics" } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/register/setup-intent": { "post": { "tags": [ "Registration" ], "summary": "Starts collecting a payment method for the public registration flow.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SetupIntent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SetupIntent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetupIntent" } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/register": { "post": { "tags": [ "Registration" ], "summary": "Registers a new account and owner using the public onboarding flow.", "requestBody": { "description": "The account registration details including selected plan, owner profile, and payment method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountWithOwnerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAccountWithOwnerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAccountWithOwnerRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicRegistrationResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PublicRegistrationResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublicRegistrationResult" } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/confirm-email": { "get": { "tags": [ "Registration" ], "summary": "Confirms a user's email address using the token sent in their registration email.", "parameters": [ { "name": "token", "in": "query", "description": "The confirmation token embedded in the email link.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/risk/signals/messages/{messageId}": { "get": { "tags": [ "Risk Signals" ], "summary": "Retrieve risk signals attributed to one of your messages.", "description": "Returns the individual risk signals that the adaptive risk engine captured while\nevaluating this message. Each signal has a type, score contribution, confidence,\nhuman-readable reason, and source provider.\n \nOnly signals belonging to messages owned by the authenticated account are accessible;\nrequests for other accounts' messages return 404.\n \nUse the optional `?signalType=` query parameter to filter results to a single type\n(e.g., `?signalType=UrlSafety`). Returns an empty list when the message was not\nevaluated or the evaluation produced no signals.\n \n**Real-time updates:** connect to the SignalR hub at\n`/hubs/user-risk-signals` to receive `ReceiveMessageSignals` events\nthe moment the risk engine evaluates a new message for your account.", "parameters": [ { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "signalType", "in": "query", "schema": { "$ref": "#/components/schemas/RiskSignalTypeEntity" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RiskSignal" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RiskSignal" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RiskSignal" } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/risk/signals/messages/{messageId}/summary": { "get": { "tags": [ "Risk Signals" ], "summary": "Retrieve the aggregated risk signal summary for one of your messages.", "description": "Returns pre-aggregated statistics for all signals captured during the message's\nlatest risk evaluation:\n- Total signals collected\n- Maximum individual score contribution\n- Average confidence across signals\n- Per signal-type counts\n- Per provider counts\n- Up to five highest-contributing signals\n \nUseful as a quick-read risk profile without fetching every individual signal.\nReturns a zeroed summary when the message has no evaluation record.\n \nOnly signals belonging to messages owned by the authenticated account are accessible;\nrequests for other accounts' messages return 404.", "parameters": [ { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskSignalSummary" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskSignalSummary" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskSignalSummary" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/risk/signals/messages/{messageId}/export": { "get": { "tags": [ "Risk Signals" ], "summary": "Export risk signals for one of your messages as CSV or JSON.", "description": "Downloads all risk signals for the requested message as a file attachment.\n \nSupported formats:\n- `format=csv` (default) — RFC 4180 CSV with a header row. Content-Type: `text/csv`.\n- `format=json` — Pretty-printed JSON array. Content-Type: `application/json`.\n \nUse the optional `?signalType=` parameter to restrict the export to a single signal type.\n \nThe response includes a `Content-Disposition: attachment` header with a filename\nthat embeds the message ID and a UTC timestamp, for example:\n`risk-signals--20260622T120000Z.csv`.\n \nOnly signals belonging to messages owned by the authenticated account are accessible;\nrequests for other accounts' messages return 404.", "parameters": [ { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "format", "in": "query", "schema": { "type": "string", "default": "csv" } }, { "name": "signalType", "in": "query", "schema": { "$ref": "#/components/schemas/RiskSignalTypeEntity" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/manual-charge": { "post": { "tags": [ "Subaccount Charges" ], "summary": "Creates a manual one-time charge against a Subaccount.", "description": "Restricted to account Admins and Managers; Associates receive 403.", "parameters": [ { "name": "subaccountId", "in": "path", "description": "ID of the subaccount to charge.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Charge details including amount, currency, and payment method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubaccountChargeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSubaccountChargeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSubaccountChargeRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SubaccountChargeResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubaccountChargeResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubaccountChargeResult" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/payments": { "get": { "tags": [ "Subaccount Charges" ], "summary": "Retrieves payment history for a Subaccount.", "parameters": [ { "name": "subaccountId", "in": "path", "description": "ID of the subaccount.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "take", "in": "query", "description": "Number of payments to return (1-500, default 50).", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubaccountPaymentEvent" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubaccountPaymentEvent" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubaccountPaymentEvent" } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/payment-methods": { "get": { "tags": [ "Subaccount Payment Methods" ], "summary": "List the available payment methods for a subaccount.", "parameters": [ { "name": "subaccountId", "in": "path", "description": "Identifier of the subaccount whose payment methods are being listed.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "post": { "tags": [ "Subaccount Payment Methods" ], "summary": "Attach a confirmed payment method to a subaccount.", "parameters": [ { "name": "subaccountId", "in": "path", "description": "Identifier of the subaccount receiving the payment method.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Card or payment method details including the payment method identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachSubaccountPaymentMethodRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttachSubaccountPaymentMethodRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AttachSubaccountPaymentMethodRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/payment-methods/setup-intent": { "post": { "tags": [ "Subaccount Payment Methods" ], "summary": "Start adding a new payment method to a subaccount.", "parameters": [ { "name": "subaccountId", "in": "path", "description": "Identifier of the subaccount for which the setup intent is created.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SubaccountSetupIntent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubaccountSetupIntent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubaccountSetupIntent" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/{paymentMethodId}/default": { "post": { "tags": [ "Subaccount Payment Methods" ], "summary": "Set a payment method as the default for the subaccount.", "parameters": [ { "name": "subaccountId", "in": "path", "description": "Identifier of the subaccount whose default payment method is being updated.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "paymentMethodId", "in": "path", "description": "Identifier of the payment method to mark as default.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/subaccounts/{subaccountId}/{paymentMethodId}": { "delete": { "tags": [ "Subaccount Payment Methods" ], "summary": "Delete a payment method from a subaccount.", "parameters": [ { "name": "subaccountId", "in": "path", "description": "Identifier of the subaccount whose payment method is being removed.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "paymentMethodId", "in": "path", "description": "Identifier of the payment method to delete.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/accounts/{accountId}/subaccounts": { "get": { "tags": [ "Subaccounts" ], "summary": "Lists all subaccounts belonging to the caller's account.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subaccount" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subaccount" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subaccount" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "post": { "tags": [ "Subaccounts" ], "summary": "Creates a new subaccount under the caller's account.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubaccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSubaccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSubaccountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Subaccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Subaccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Subaccount" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/accounts/{accountId}/subaccounts/{subaccountId}": { "get": { "tags": [ "Subaccounts" ], "summary": "Returns a single subaccount by ID.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Subaccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Subaccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Subaccount" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "put": { "tags": [ "Subaccounts" ], "summary": "Updates the name or settings of an existing subaccount.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSubaccountRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSubaccountRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSubaccountRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Subaccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Subaccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Subaccount" } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Subaccounts" ], "summary": "Deletes a subaccount from the caller's account.", "parameters": [ { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "subaccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/support/cases": { "post": { "tags": [ "Support Cases" ], "summary": "Creates a new support case for the authenticated account.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSupportCaseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSupportCaseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSupportCaseRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SupportCase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SupportCase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "get": { "tags": [ "Support Cases" ], "summary": "Lists all support cases for the authenticated account with pagination.", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SupportCaseListResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SupportCaseListResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupportCaseListResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/support/cases/{id}": { "get": { "tags": [ "Support Cases" ], "summary": "Returns a single support case by ID, scoped to the authenticated account.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SupportCase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/support/cases/by-reference/{referenceNumber}": { "get": { "tags": [ "Support Cases" ], "summary": "Returns a support case by its human-readable reference number.", "parameters": [ { "name": "referenceNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SupportCase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/support/cases/{id}/comments": { "post": { "tags": [ "Support Cases" ], "summary": "Appends a user comment to an existing support case.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddSupportCaseCommentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddSupportCaseCommentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddSupportCaseCommentRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SupportCase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/support/cases/{id}/reopen": { "post": { "tags": [ "Support Cases" ], "summary": "Reopens a closed support case with optional notes.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReopenSupportCaseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReopenSupportCaseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReopenSupportCaseRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SupportCase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupportCase" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/webhooks/tcr": { "post": { "tags": [ "TCR Webhooks" ], "summary": "Receives and processes a TCR webhook payload after signature verification.", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/templates": { "get": { "tags": [ "Templates" ], "summary": "List all templates for the authenticated user's account.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageTemplate" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageTemplate" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageTemplate" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "post": { "tags": [ "Templates" ], "summary": "Create a new message template.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMessageTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateMessageTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateMessageTemplateRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MessageTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MessageTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MessageTemplate" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/templates/{templateId}": { "get": { "tags": [ "Templates" ], "summary": "Get a specific template by ID (must belong to user's account).", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MessageTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MessageTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MessageTemplate" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "put": { "tags": [ "Templates" ], "summary": "Update an existing template.", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMessageTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateMessageTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateMessageTemplateRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MessageTemplate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MessageTemplate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MessageTemplate" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Templates" ], "summary": "Soft-delete a template.", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/templates/{templateId}/render": { "post": { "tags": [ "Templates" ], "summary": "Render a saved template with provided variables.", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenderTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RenderTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RenderTemplateRequest" } } } }, "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/templates/preview": { "post": { "tags": [ "Templates" ], "summary": "Preview a template body without saving. Useful for live preview in the UI.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplatePreviewRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplatePreviewRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TemplatePreviewRequest" } } } }, "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/token/refresh": { "post": { "tags": [ "Token Management" ], "summary": "Refresh access token using a refresh token", "requestBody": { "description": "Refresh token request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshTokenRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefreshTokenRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RefreshTokenRequest" } } } }, "responses": { "200": { "description": "OK" }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } }, "/v1/auth/token/revoke": { "post": { "tags": [ "Token Management" ], "summary": "Revoke the current refresh token (logout)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeTokenRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RevokeTokenRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RevokeTokenRequest" } } } }, "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/token/sessions": { "get": { "tags": [ "Token Management" ], "summary": "Get active sessions for the current user", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/token/sessions/{sessionId}": { "delete": { "tags": [ "Token Management" ], "summary": "Terminate a specific session", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/auth/token/sessions/terminate-others": { "post": { "tags": [ "Token Management" ], "summary": "Terminate all other sessions (logout everywhere else)", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/webhooks": { "get": { "tags": [ "Webhooks" ], "summary": "List all webhooks for the authenticated user's account.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEndpoint" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEndpoint" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEndpoint" } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "post": { "tags": [ "Webhooks" ], "summary": "Create a new webhook endpoint. The signing secret is returned once.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookEndpointRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookEndpointRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateWebhookEndpointRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookEndpoint" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpoint" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpoint" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/webhooks/{webhookId}": { "get": { "tags": [ "Webhooks" ], "summary": "Get a specific webhook by ID (must belong to user's account).", "parameters": [ { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookEndpoint" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpoint" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpoint" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "put": { "tags": [ "Webhooks" ], "summary": "Update a webhook endpoint (URL, label, events, active status).", "parameters": [ { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookEndpointRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookEndpointRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookEndpointRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookEndpoint" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpoint" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpoint" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] }, "delete": { "tags": [ "Webhooks" ], "summary": "Soft-delete a webhook endpoint.", "parameters": [ { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/webhooks/{webhookId}/rotate-secret": { "post": { "tags": [ "Webhooks" ], "summary": "Rotate the signing secret. Returns the new secret (shown once).", "parameters": [ { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/webhooks/{webhookId}/test": { "post": { "tags": [ "Webhooks" ], "summary": "Send a test webhook payload to the endpoint.", "parameters": [ { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryLog" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/webhooks/{webhookId}/deliveries": { "get": { "tags": [ "Webhooks" ], "summary": "Get delivery logs for a webhook endpoint (paginated).", "parameters": [ { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDeliveryLog" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDeliveryLog" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDeliveryLog" } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/webhooks/{webhookId}/deliveries/{deliveryLogId}/replay": { "post": { "tags": [ "Webhooks" ], "summary": "Replay a specific delivery log as a safe test dispatch for diagnostics.\nIncludes ownership checks and short cooldown idempotency guardrails.", "parameters": [ { "name": "webhookId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deliveryLogId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryLog" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "401": { "description": "Unauthorized — missing or invalid credentials.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "403": { "description": "Forbidden — insufficient permissions.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ { } ] } }, "/v1/webhooks/whatsapp": { "get": { "tags": [ "WhatsApp Webhooks" ], "summary": "Handles Meta's webhook verification challenge (GET request).\nMeta sends: ?hub.mode=subscribe&hub.challenge=CHALLENGE_TOKEN&hub.verify_token=VERIFY_TOKEN\nWe must echo back the challenge if the verify token matches.", "parameters": [ { "name": "hub.mode", "in": "query", "schema": { "type": "string" } }, { "name": "hub.challenge", "in": "query", "schema": { "type": "string" } }, { "name": "hub.verify_token", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] }, "post": { "tags": [ "WhatsApp Webhooks" ], "summary": "Receives delivery receipt and message status events from Meta's WhatsApp Business Platform.\n \nExpected webhook payload structure:\n{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [{\n \"id\": \"ACCOUNT_ID\",\n \"changes\": [{\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"statuses\": [{\n \"id\": \"wamid.xxxxx\",\n \"status\": \"delivered|sent|read|failed\",\n \"recipient_id\": \"+16175551234\",\n \"timestamp\": \"1671794240\"\n }]\n },\n \"field\": \"messages\"\n }]\n }]\n}", "requestBody": { "content": { "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "200": { "description": "OK" }, "422": { "description": "Validation error — request body failed validation.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "429": { "description": "Too many requests — rate limit exceeded.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } }, "500": { "description": "Unexpected server error.", "content": { "application/problem+json": { "schema": { "required": [ "type", "title", "status", "code", "traceId" ], "type": "object", "properties": { "type": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "code": { "type": "string" }, "traceId": { "type": "string" }, "errors": { "type": "object" }, "retryAfterSeconds": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32" }, "monthlyRemaining": { "type": "integer", "format": "int32" }, "attemptsRemaining": { "type": "integer", "format": "int32" }, "authScheme": { "type": "string" }, "mfaToken": { "type": "string" }, "mfaTokenExpiresAt": { "type": "string", "format": "date-time" }, "mfaMethods": { "type": "array", "items": { "type": "string" } }, "enrollmentToken": { "type": "string" }, "enrollmentTokenExpiresAt": { "type": "string", "format": "date-time" }, "externalEmail": { "type": "string", "format": "email" }, "paymentIntentId": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" }, "accountId": { "type": "string", "format": "uuid" }, "compatibleProviders": { "type": "array", "items": { "type": "object" } } } } } } } }, "security": [ ] } } }, "components": { "schemas": { "AcceptInvitationRequest": { "required": [ "invitationToken", "password" ], "type": "object", "properties": { "invitationToken": { "minLength": 1, "type": "string" }, "password": { "maxLength": 128, "minLength": 12, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[^A-Za-z0-9]).{12,}$", "type": "string" } }, "additionalProperties": false }, "Account": { "title": "Account", "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "streetAddress1": { "type": "string", "nullable": true }, "streetAddress2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "stateOrProvince": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/AccountStatusEntity" }, "createdAt": { "type": "string", "format": "date-time" }, "payoutAccountId": { "type": "string", "nullable": true }, "isPayoutOnboardingComplete": { "type": "boolean" }, "payoutOnboardingCompletedAt": { "type": "string", "format": "date-time", "nullable": true }, "platformFeeBps": { "type": "integer", "format": "int32" }, "outboundDispatchEnabled": { "type": "boolean" }, "outboundDispatchHeldAt": { "type": "string", "format": "date-time", "nullable": true }, "outboundDispatchHeldBy": { "type": "string", "nullable": true }, "outboundDispatchHoldReason": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Public Account payload returned by the API." }, "AccountActivityTimeline": { "title": "AccountActivityTimeline", "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "windowStartUtc": { "type": "string", "format": "date-time" }, "windowEndUtc": { "type": "string", "format": "date-time" }, "searchTerm": { "type": "string", "nullable": true }, "activityType": { "type": "string", "nullable": true }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccountActivityTimelineItem" }, "nullable": true } }, "additionalProperties": false, "description": "Public AccountActivityTimeline payload returned by the API." }, "AccountActivityTimelineItem": { "title": "AccountActivityTimelineItem", "type": "object", "properties": { "source": { "type": "string", "nullable": true }, "activityType": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "success": { "type": "boolean" }, "timestampUtc": { "type": "string", "format": "date-time" }, "tableName": { "type": "string", "nullable": true }, "entityId": { "type": "string", "format": "uuid", "nullable": true }, "ipAddress": { "type": "string", "nullable": true }, "userAgent": { "type": "string", "nullable": true }, "failureReason": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Public AccountActivityTimelineItem payload returned by the API." }, "AccountBalance": { "title": "AccountBalance", "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "balanceUsd": { "type": "number", "format": "double" }, "unbilledChargesUsd": { "type": "number", "format": "double" }, "invoicedDueUsd": { "type": "number", "format": "double" }, "accountCreditUsd": { "type": "number", "format": "double" }, "totalChargedUsd": { "type": "number", "format": "double" }, "totalCreditedUsd": { "type": "number", "format": "double" }, "totalPaidUsd": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true }, "asOf": { "type": "string", "format": "date-time" }, "openInvoices": { "type": "array", "items": { "$ref": "#/components/schemas/OpenInvoiceDue" }, "nullable": true } }, "additionalProperties": false, "description": "Public AccountBalance payload returned by the API." }, "AccountOnboardingStatus": { "title": "AccountOnboardingStatus", "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "accountName": { "type": "string", "nullable": true }, "ownerEmail": { "type": "string", "nullable": true }, "accountStatus": { "$ref": "#/components/schemas/AccountStatusEntity" }, "checklistCreatedAt": { "type": "string", "format": "date-time" }, "emailVerified": { "type": "boolean" }, "emailVerifiedAt": { "type": "string", "format": "date-time", "nullable": true }, "paymentMethodAttached": { "type": "boolean" }, "paymentMethodAttachedAt": { "type": "string", "format": "date-time", "nullable": true }, "requiresStaffReview": { "type": "boolean" }, "staffReviewApproved": { "type": "boolean" }, "staffReviewedAt": { "type": "string", "format": "date-time", "nullable": true }, "isReadyForActivation": { "type": "boolean" }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "nudgeCount": { "type": "integer", "format": "int32" }, "lastNudgeAt": { "type": "string", "format": "date-time", "nullable": true }, "blockers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "messagingConfigurationCompleted": { "type": "boolean" }, "messagingConfigurationCompletedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Public AccountOnboardingStatus payload returned by the API." }, "AccountOptOutScopeChoice": { "enum": [ "AccountLevelOnly", "EntireAccount" ], "type": "string" }, "AccountQuota": { "title": "AccountQuota", "type": "object", "properties": { "accountQuotaId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "dailyLimit": { "type": "integer", "format": "int32", "nullable": true }, "monthlyLimit": { "type": "integer", "format": "int32", "nullable": true }, "ratePerSecond": { "type": "integer", "format": "int32", "nullable": true }, "ratePerMinute": { "type": "integer", "format": "int32", "nullable": true }, "dailyUsed": { "type": "integer", "format": "int32" }, "monthlyUsed": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32", "nullable": true }, "monthlyRemaining": { "type": "integer", "format": "int32", "nullable": true }, "lastDailyReset": { "type": "string", "format": "date-time" }, "lastMonthlyReset": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Public AccountQuota payload returned by the API." }, "AccountSecurityPolicyRequest": { "type": "object", "properties": { "requireMfa": { "type": "boolean" } }, "additionalProperties": false }, "AccountSecurityPolicyResponse": { "type": "object", "properties": { "requireMfa": { "type": "boolean" }, "changedAt": { "type": "string", "format": "date-time", "nullable": true }, "enrolledUsers": { "type": "integer", "format": "int32" }, "totalUsers": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AccountStatusEntity": { "enum": [ "Active", "Suspended", "Closed", "Archived", "PendingVerification" ], "type": "string", "x-internal": true }, "AccountSubscription": { "title": "AccountSubscription", "type": "object", "properties": { "subscriptionId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "accountName": { "type": "string", "nullable": true }, "planId": { "type": "string", "format": "uuid" }, "planName": { "type": "string", "nullable": true }, "cycle": { "$ref": "#/components/schemas/BillingCycleEntity" }, "status": { "$ref": "#/components/schemas/SubscriptionStatusEntity" }, "startDate": { "type": "string", "format": "date-time" }, "currentPeriodStart": { "type": "string", "format": "date-time" }, "currentPeriodEnd": { "type": "string", "format": "date-time" }, "cancelledAt": { "type": "string", "format": "date-time", "nullable": true }, "cancelEffectiveDate": { "type": "string", "format": "date-time", "nullable": true }, "externalSubscriptionId": { "type": "string", "nullable": true }, "externalCustomerId": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Public AccountSubscription payload returned by the API." }, "AccountUser": { "title": "AccountUser", "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "role": { "$ref": "#/components/schemas/UserRoleEntity" }, "isOwner": { "type": "boolean" }, "isActive": { "type": "boolean" }, "isEmailConfirmed": { "type": "boolean" }, "hasPendingInvitation": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "mfaEnabled": { "type": "boolean" } }, "additionalProperties": false, "description": "Public AccountUser payload returned by the API." }, "AddSupportCaseCommentRequest": { "type": "object", "properties": { "body": { "type": "string", "nullable": true }, "isInternal": { "type": "boolean" } }, "additionalProperties": false }, "ApiKey": { "title": "ApiKey", "type": "object", "properties": { "apiKeyId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "label": { "type": "string", "nullable": true }, "permissions": { "$ref": "#/components/schemas/ApiKeyRightsEntity" }, "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "isRevoked": { "type": "boolean" }, "isActive": { "type": "boolean" }, "lastUsedAt": { "type": "string", "format": "date-time", "nullable": true }, "usageCount": { "type": "integer", "format": "int64" }, "keyValue": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Public ApiKey payload returned by the API." }, "ApiKeyEndpointUsage": { "title": "ApiKeyEndpointUsage", "type": "object", "properties": { "method": { "type": "string", "nullable": true }, "endpoint": { "type": "string", "nullable": true }, "requestCount": { "type": "integer", "format": "int64" }, "errorCount": { "type": "integer", "format": "int64" }, "errorRatePercent": { "type": "number", "format": "double" }, "averageResponseTimeMs": { "type": "number", "format": "double" } }, "additionalProperties": false, "description": "Public ApiKeyEndpointUsage payload returned by the API." }, "ApiKeyRightsEntity": { "enum": [ "None", "ReadAccounts", "ManageAccounts", "ReadSubaccounts", "ManageSubaccounts", "ReadMessages", "CreateMessages", "TransitionMessages", "DeleteMessages", "ManageTemplates", "ReadRecipientConsent", "ManageRecipientConsent", "FullAccess" ], "type": "string", "x-internal": true }, "ApiKeyUsage": { "title": "ApiKeyUsage", "type": "object", "properties": { "apiKeyId": { "type": "string", "format": "uuid" }, "totalRequests": { "type": "integer", "format": "int64" }, "lastUsedAt": { "type": "string", "format": "date-time", "nullable": true }, "requestsLastMinute": { "type": "integer", "format": "int32" }, "requestsLastHour": { "type": "integer", "format": "int32" }, "requestsLastDay": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Public ApiKeyUsage payload returned by the API." }, "ApiKeyUsageAnalytics": { "title": "ApiKeyUsageAnalytics", "type": "object", "properties": { "windowStartUtc": { "type": "string", "format": "date-time" }, "windowEndUtc": { "type": "string", "format": "date-time" }, "windowHours": { "type": "integer", "format": "int32" }, "totalRequests": { "type": "integer", "format": "int64" }, "errorRequests": { "type": "integer", "format": "int64" }, "errorRatePercent": { "type": "number", "format": "double" }, "averageResponseTimeMs": { "type": "number", "format": "double" }, "trend": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyUsageTrendPoint" }, "nullable": true }, "topEndpoints": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyEndpointUsage" }, "nullable": true }, "anomalies": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyUsageAnomaly" }, "nullable": true } }, "additionalProperties": false, "description": "Public ApiKeyUsageAnalytics payload returned by the API." }, "ApiKeyUsageAnomaly": { "title": "ApiKeyUsageAnomaly", "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "severity": { "type": "string", "nullable": true }, "summary": { "type": "string", "nullable": true }, "observedAtUtc": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Public ApiKeyUsageAnomaly payload returned by the API." }, "ApiKeyUsageTrendPoint": { "title": "ApiKeyUsageTrendPoint", "type": "object", "properties": { "bucketStartUtc": { "type": "string", "format": "date-time" }, "bucketEndUtc": { "type": "string", "format": "date-time" }, "requestCount": { "type": "integer", "format": "int64" }, "errorCount": { "type": "integer", "format": "int64" }, "errorRatePercent": { "type": "number", "format": "double" } }, "additionalProperties": false, "description": "Public ApiKeyUsageTrendPoint payload returned by the API." }, "AssignPhoneNumberRequest": { "type": "object", "properties": { "subaccountId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AssignPlanRequest": { "type": "object", "properties": { "planId": { "type": "string", "format": "uuid" }, "cycle": { "$ref": "#/components/schemas/BillingCycleEntity" }, "externalCustomerId": { "type": "string", "nullable": true }, "externalSubscriptionId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttachSubaccountPaymentMethodRequest": { "type": "object", "properties": { "externalPaymentMethodId": { "type": "string", "description": "Payment method identifier for the card or wallet instrument being attached.", "nullable": true }, "setAsDefault": { "type": "boolean", "description": "Whether the attached payment method should become the subaccount's default payment method." } }, "additionalProperties": false, "description": "Body for attaching a previously confirmed payment method to a subaccount." }, "AuditTypeEntity": { "enum": [ "Transition", "Duplicate", "Event" ], "type": "string", "x-internal": true }, "AuthorizeProviderRequest": { "type": "object", "properties": { "providerId": { "type": "string", "description": "Provider ID to authorize with.", "format": "uuid" }, "redirectUri": { "type": "string", "description": "Redirect URI after user authorizes.\nMust match provider's registered redirect URIs.", "nullable": true }, "codeChallenge": { "type": "string", "description": "PKCE code challenge (SHA256(code_verifier)).\nUsed for secure code exchange.", "nullable": true } }, "additionalProperties": false, "description": "Request to get authorization URL for OAuth2 provider." }, "AuthorizeProviderResponse": { "type": "object", "properties": { "authorizationUrl": { "type": "string", "description": "Authorization URL to redirect user to.", "nullable": true }, "state": { "type": "string", "description": "CSRF protection state (random unique value).\nMust be stored and verified after callback.", "nullable": true } }, "additionalProperties": false, "description": "Response containing authorization URL." }, "AvailableNumber": { "title": "AvailableNumber", "type": "object", "properties": { "e164Number": { "type": "string", "nullable": true }, "numberType": { "$ref": "#/components/schemas/PhoneNumberTypeEntity" }, "capabilities": { "$ref": "#/components/schemas/PhoneNumberCapabilityEntity" }, "monthlyFeeCents": { "type": "integer", "format": "int32" }, "regionCode": { "type": "string", "nullable": true }, "areaCode": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Public AvailableNumber payload returned by the API." }, "BillingCycle": { "title": "BillingCycle", "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid", "nullable": true }, "periodStart": { "type": "string", "format": "date-time", "nullable": true }, "periodEnd": { "type": "string", "format": "date-time", "nullable": true }, "planName": { "type": "string", "nullable": true }, "balance": { "$ref": "#/components/schemas/AccountBalance" }, "openBalanceUsd": { "type": "number", "format": "double" }, "unbilledEventCount": { "type": "integer", "format": "int32" }, "eventCount": { "type": "integer", "format": "int32" }, "hasBillingCustomer": { "type": "boolean" }, "canChargeOpenBalance": { "type": "boolean" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/BillingEvent" }, "nullable": true } }, "additionalProperties": false, "description": "Public BillingCycle payload returned by the API." }, "BillingCycleEntity": { "enum": [ "Monthly", "Annual" ], "type": "string", "x-internal": true }, "BillingEvent": { "title": "BillingEvent", "type": "object", "properties": { "billingEventId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "referenceId": { "type": "string", "format": "uuid", "nullable": true }, "invoiceId": { "type": "string", "format": "uuid", "nullable": true }, "settledAt": { "type": "string", "format": "date-time", "nullable": true }, "eventType": { "$ref": "#/components/schemas/BillingEventTypeEntity" }, "description": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "format": "int32" }, "unitPriceUsd": { "type": "number", "format": "double" }, "totalUsd": { "type": "number", "format": "double" }, "occurredAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Public BillingEvent payload returned by the API." }, "BillingEventTypeEntity": { "enum": [ "SubscriptionFee", "MessageUsage", "OverageFee", "BrandFee", "PhoneNumberRental", "InboundSms", "PhoneNumberSetup", "CampaignFee", "CampaignMonthlyFee", "StandardVettingFee", "EnhancedVettingFee", "PoliticalVettingFee", "BrandAppealFee", "VettingAppealFee", "BrandResubmitFee", "CampaignResubmitFee", "NumberConnectivityFee" ], "type": "string", "x-internal": true }, "CardPaymentRequest": { "type": "object", "properties": { "amountUsd": { "type": "number", "format": "double" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CardPaymentResult": { "title": "CardPaymentResult", "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "paymentId": { "type": "string", "format": "uuid" }, "amountUsd": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true }, "paymentReference": { "type": "string", "nullable": true }, "processedAt": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Public CardPaymentResult payload returned by the API." }, "CarrierEventRequest": { "type": "object", "properties": { "event": { "$ref": "#/components/schemas/CarrierMessageEventEntity" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CarrierMessageEventEntity": { "enum": [ "Accepted", "Delivered", "Failed", "Rejected" ], "type": "string", "x-internal": true }, "ChangeUserPasswordRequest": { "required": [ "currentPassword", "newPassword" ], "type": "object", "properties": { "currentPassword": { "minLength": 1, "type": "string" }, "newPassword": { "maxLength": 128, "minLength": 12, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[^A-Za-z0-9]).{12,}$", "type": "string" } }, "additionalProperties": false }, "ChannelCostBreakdown": { "title": "ChannelCostBreakdown", "type": "object", "properties": { "channelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "totalAttempts": { "type": "integer", "format": "int32" }, "totalCarrierCostUsd": { "type": "number", "format": "double" }, "totalCustomerChargeUsd": { "type": "number", "format": "double" } }, "additionalProperties": false, "description": "Public ChannelCostBreakdown payload returned by the API." }, "ChannelOptInRequest": { "required": [ "channelType", "subaccountId" ], "type": "object", "properties": { "channelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "subaccountId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ChannelOptOut": { "title": "ChannelOptOut", "type": "object", "properties": { "channelOptOutId": { "type": "string", "format": "uuid" }, "subaccountId": { "type": "string", "format": "uuid" }, "channelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "recipientId": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true }, "actor": { "type": "string", "nullable": true }, "optedOutAt": { "type": "string", "format": "date-time" }, "optedInAt": { "type": "string", "format": "date-time", "nullable": true }, "isOptedOut": { "type": "boolean" } }, "additionalProperties": false, "description": "Public ChannelOptOut payload returned by the API." }, "ChannelOptOutRequest": { "required": [ "channelType", "subaccountId" ], "type": "object", "properties": { "channelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "subaccountId": { "type": "string", "format": "uuid" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChannelPreferenceStatus": { "title": "ChannelPreferenceStatus", "type": "object", "properties": { "channelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "isOptedOut": { "type": "boolean" } }, "additionalProperties": false, "description": "Public ChannelPreferenceStatus payload returned by the API." }, "ChannelRoutePreview": { "title": "ChannelRoutePreview", "type": "object", "properties": { "subaccountId": { "type": "string", "format": "uuid" }, "requestedChannelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "orderedRoute": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "nullable": true } }, "additionalProperties": false, "description": "Public ChannelRoutePreview payload returned by the API." }, "ChannelRoutingPolicy": { "title": "ChannelRoutingPolicy", "type": "object", "properties": { "channelRoutingPolicyId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "subaccountId": { "type": "string", "format": "uuid" }, "preferredChannelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "fallbackChain": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "nullable": true }, "isEnabled": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "receiptTimeoutSeconds": { "type": "integer", "format": "int32", "nullable": true }, "fallbackOnDeliveryFailure": { "type": "boolean" } }, "additionalProperties": false, "description": "Public ChannelRoutingPolicy payload returned by the API." }, "ChannelTypeEntity": { "enum": [ "Unknown", "Sms", "Email", "WhatsApp", "Slack", "InAppPush", "Rcs" ], "type": "string", "x-internal": true }, "ConfigureWebhookRequest": { "type": "object", "properties": { "webhookUrl": { "type": "string", "description": "The absolute URL where payment provider webhooks should be delivered.", "nullable": true } }, "additionalProperties": false, "description": "Request to configure webhook" }, "ConsentCategoryEntity": { "enum": [ "Marketing", "Analytics", "Profiling", "ThirdPartySharing" ], "type": "string", "x-internal": true }, "ConsentImportResult": { "title": "ConsentImportResult", "type": "object", "properties": { "totalRows": { "type": "integer", "format": "int32" }, "created": { "type": "integer", "format": "int32" }, "alreadyExists": { "type": "integer", "format": "int32" }, "duplicatesInFile": { "type": "integer", "format": "int32" }, "invalid": { "type": "integer", "format": "int32" }, "fileSha256": { "type": "string", "nullable": true }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ConsentImportRow" }, "nullable": true } }, "additionalProperties": false, "description": "Public ConsentImportResult payload returned by the API." }, "ConsentImportRow": { "title": "ConsentImportRow", "type": "object", "properties": { "line": { "type": "integer", "format": "int32" }, "recipient": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Public ConsentImportRow payload returned by the API." }, "ConsentRecord": { "title": "ConsentRecord", "type": "object", "properties": { "consentId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "category": { "$ref": "#/components/schemas/ConsentCategoryEntity" }, "isGranted": { "type": "boolean" }, "consentVersion": { "type": "string", "nullable": true }, "ipAddress": { "type": "string", "nullable": true }, "userAgent": { "type": "string", "nullable": true }, "grantedAt": { "type": "string", "format": "date-time" }, "revokedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Public ConsentRecord payload returned by the API." }, "ContentFormatEntity": { "enum": [ "Unknown", "Sms", "Mms" ], "type": "string", "x-internal": true }, "CreateAccountRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateAccountWithOwnerRequest": { "required": [ "accountName", "ownerEmail", "ownerFirstName", "ownerLastName", "ownerPassword", "ownerRole", "planName", "primaryMessagingUseCase" ], "type": "object", "properties": { "accountName": { "maxLength": 100, "minLength": 0, "type": "string" }, "streetAddress1": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "streetAddress2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "city": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "stateOrProvince": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "postalCode": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "country": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "emailAddress": { "maxLength": 320, "minLength": 0, "type": "string", "format": "email", "nullable": true }, "phoneNumber": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "planName": { "maxLength": 100, "minLength": 0, "type": "string" }, "teamSize": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "industryCode": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "primaryMessagingUseCase": { "maxLength": 1000, "minLength": 10, "type": "string" }, "externalPaymentMethodId": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "ownerFirstName": { "maxLength": 100, "minLength": 0, "type": "string" }, "ownerLastName": { "maxLength": 100, "minLength": 0, "type": "string" }, "ownerEmail": { "maxLength": 320, "minLength": 0, "type": "string", "format": "email" }, "ownerPassword": { "maxLength": 128, "minLength": 12, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[^A-Za-z0-9]).{12,}$", "type": "string" }, "ownerRole": { "$ref": "#/components/schemas/UserRoleEntity" }, "captchaToken": { "maxLength": 2048, "minLength": 0, "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateApiKeyRequest": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "label": { "type": "string", "nullable": true }, "permissions": { "$ref": "#/components/schemas/ApiKeyRightsEntity" } }, "additionalProperties": false }, "CreateMessageRequest": { "required": [ "actor", "channelType", "messageType" ], "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "channelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "destination": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "templateId": { "type": "string", "format": "uuid", "nullable": true }, "templateVariables": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "clientReference": { "type": "string", "nullable": true }, "sendAt": { "type": "string", "format": "date-time", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "priority": { "$ref": "#/components/schemas/DispatchPriorityEntity" }, "pushTopics": { "type": "array", "items": { "type": "string" }, "nullable": true }, "pushUserIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "messageType": { "$ref": "#/components/schemas/MessageTypeEntity" }, "actor": { "minLength": 1, "type": "string" }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateMessageTemplateRequest": { "required": [ "bodyTemplate", "channelType", "name" ], "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "channelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "bodyTemplate": { "maxLength": 2000, "minLength": 1, "type": "string" }, "defaultVariables": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "replyOptions": { "type": "array", "items": { "$ref": "#/components/schemas/ReplyOption" }, "nullable": true } }, "additionalProperties": false }, "CreateNumberPoolRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "strategy": { "$ref": "#/components/schemas/PoolSelectionStrategyEntity" }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CreateProviderRequest": { "type": "object", "properties": { "providerType": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "clientId": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "redirectUri": { "type": "string", "nullable": true }, "tenantId": { "type": "string", "nullable": true }, "scopes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CreateSubaccountChargeRequest": { "type": "object", "properties": { "amountMinor": { "type": "integer", "description": "Amount to charge in minor currency units (e.g., cents).", "format": "int64" }, "currency": { "type": "string", "description": "Currency code (e.g., USD).", "nullable": true }, "idempotencyKey": { "type": "string", "description": "Idempotency key to prevent duplicate charges.", "nullable": true }, "externalPaymentMethodId": { "type": "string", "description": "Optional payment method id; if not provided, the default is used.", "nullable": true }, "description": { "type": "string", "description": "Optional charge description.", "nullable": true }, "statementDescriptorSuffix": { "type": "string", "description": "Optional statement descriptor suffix for the charge.", "nullable": true }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional metadata key-value pairs.", "nullable": true } }, "additionalProperties": false, "description": "Body for a user-initiated manual charge of a Subaccount." }, "CreateSubaccountRequest": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true }, "createdBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateSupportCaseRequest": { "type": "object", "properties": { "category": { "$ref": "#/components/schemas/SupportCaseCategoryEntity" }, "severity": { "$ref": "#/components/schemas/SupportCaseSeverityEntity" }, "subject": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "relatedMessageId": { "type": "string", "format": "uuid", "nullable": true }, "relatedWebhookEndpointId": { "type": "string", "format": "uuid", "nullable": true }, "relatedRequestId": { "type": "string", "nullable": true }, "relatedComplianceIncidentId": { "type": "string", "format": "uuid", "nullable": true }, "metadataJson": { "type": "string", "nullable": true }, "preferredContactMethod": { "$ref": "#/components/schemas/SupportContactMethodEntity" }, "source": { "$ref": "#/components/schemas/SupportCaseSourceEntity" } }, "additionalProperties": false }, "CreateTenDlcCampaignRequest": { "type": "object", "properties": { "brandId": { "type": "string", "format": "uuid" }, "useCase": { "$ref": "#/components/schemas/TenDlcUseCaseEntity" }, "subUseCases": { "type": "array", "items": { "type": "string" }, "nullable": true }, "carrierName": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "messageFlow": { "type": "string", "nullable": true }, "sampleMessage1": { "type": "string", "nullable": true }, "sampleMessage2": { "type": "string", "nullable": true }, "sampleMessage3": { "type": "string", "nullable": true }, "sampleMessage4": { "type": "string", "nullable": true }, "sampleMessage5": { "type": "string", "nullable": true }, "embeddedLink": { "type": "boolean" }, "embeddedPhone": { "type": "boolean" }, "ageGated": { "type": "boolean" }, "directLending": { "type": "boolean" }, "affiliateMarketing": { "type": "boolean" }, "subscriberOptin": { "type": "boolean" }, "subscriberOptout": { "type": "boolean" }, "subscriberHelp": { "type": "boolean" } }, "additionalProperties": false }, "CreateWebhookEndpointRequest": { "required": [ "label", "subscribedEvents", "url" ], "type": "object", "properties": { "url": { "minLength": 1, "type": "string", "format": "uri" }, "label": { "maxLength": 200, "minLength": 1, "type": "string" }, "subscribedEvents": { "$ref": "#/components/schemas/WebhookEventTypeEntity" }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CustomerTransaction": { "title": "CustomerTransaction", "type": "object", "properties": { "transactionId": { "type": "string", "format": "uuid" }, "occurredAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "amountUsd": { "type": "number", "format": "double" }, "balanceAfterUsd": { "type": "number", "format": "double" }, "invoiceId": { "type": "string", "format": "uuid", "nullable": true }, "invoiceNumber": { "type": "string", "nullable": true }, "isReversal": { "type": "boolean" } }, "additionalProperties": false, "description": "Public CustomerTransaction payload returned by the API." }, "CustomerTransactionPage": { "title": "CustomerTransactionPage", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerTransaction" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true }, "currentBalanceUsd": { "type": "number", "format": "double" } }, "additionalProperties": false, "description": "Public CustomerTransactionPage payload returned by the API." }, "DataSubjectRequest": { "title": "DataSubjectRequest", "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "requestType": { "$ref": "#/components/schemas/DataSubjectRequestTypeEntity" }, "status": { "$ref": "#/components/schemas/DataSubjectRequestStatusEntity" }, "exportFormat": { "$ref": "#/components/schemas/ExportFormatEntity" }, "exportFileUrl": { "type": "string", "nullable": true }, "exportExpiresAt": { "type": "string", "format": "date-time", "nullable": true }, "failureReason": { "type": "string", "nullable": true }, "requestedAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Public DataSubjectRequest payload returned by the API." }, "DataSubjectRequestStatusEntity": { "enum": [ "Pending", "InProgress", "Completed", "Failed" ], "type": "string", "x-internal": true }, "DataSubjectRequestTypeEntity": { "enum": [ "Export", "Erasure" ], "type": "string", "x-internal": true }, "DiscoverProviderRequest": { "type": "object", "properties": { "email": { "type": "string", "description": "The user's email address used to resolve a matching provider configuration.", "nullable": true } }, "additionalProperties": false, "description": "Request to discover a provider." }, "DiscoverProviderResponse": { "type": "object", "properties": { "providerId": { "type": "string", "format": "uuid", "nullable": true }, "providerName": { "type": "string", "nullable": true }, "found": { "type": "boolean" } }, "additionalProperties": false }, "DispatchPriorityEntity": { "enum": [ "Normal", "Urgent" ], "type": "string", "x-internal": true }, "EmailOtpPurposeEntity": { "enum": [ "Login", "StepUp", "EmailVerification" ], "type": "string", "x-internal": true }, "ExportFormatEntity": { "enum": [ "CSV", "Excel", "PDF", "JSON" ], "type": "string", "x-internal": true }, "ExternalAuthProviderResponse": { "type": "object", "properties": { "providerId": { "type": "string", "format": "uuid" }, "providerType": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "config": { "nullable": true } }, "additionalProperties": false }, "ExternalIdentityResponse": { "type": "object", "properties": { "identityId": { "type": "string", "description": "Unique ID of the external identity record.", "format": "uuid" }, "userId": { "type": "string", "description": "ArelHub user ID associated with this external identity.", "format": "uuid" }, "providerId": { "type": "string", "description": "ID of the sign-in provider this identity belongs to.", "format": "uuid" }, "providerType": { "type": "string", "description": "Provider type such as Google, Microsoft, or OIDC.", "nullable": true }, "providerDisplayName": { "type": "string", "description": "Human-friendly display name of the provider.", "nullable": true }, "externalSubject": { "type": "string", "description": "Subject identifier returned by the external provider.", "nullable": true }, "email": { "type": "string", "description": "The email address associated with the external identity if available.", "nullable": true }, "displayName": { "type": "string", "description": "The display name retrieved from the provider profile.", "nullable": true }, "profilePictureUrl": { "type": "string", "description": "Optional URL to the provider profile picture.", "nullable": true }, "isPrimaryIdentity": { "type": "boolean", "description": "True when this is the primary identity for the user." }, "isActive": { "type": "boolean", "description": "True when the external identity is active." }, "linkedAt": { "type": "string", "description": "Timestamp when the identity was first linked.", "format": "date-time" }, "unlinkedAt": { "type": "string", "description": "Timestamp when the identity was unlinked, if applicable.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Response DTO for external identity information." }, "ExternalUserLoginRequest": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "codeVerifier": { "type": "string", "nullable": true }, "providerType": { "type": "string", "nullable": true }, "error": { "type": "string", "nullable": true }, "errorDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ForgotUserPasswordRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "minLength": 1, "type": "string", "format": "email" } }, "additionalProperties": false }, "InboundMessage": { "title": "InboundMessage", "type": "object", "properties": { "inboundMessageId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "channelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "from": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "receivedAt": { "type": "string", "format": "date-time" }, "keyword": { "type": "string", "nullable": true }, "inReplyToMessageId": { "type": "string", "format": "uuid", "nullable": true }, "inReplyToClientReference": { "type": "string", "nullable": true }, "replyOptionKey": { "type": "string", "nullable": true }, "replyOptionValue": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Public InboundMessage payload returned by the API." }, "InboundMessagePage": { "title": "InboundMessagePage", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/InboundMessage" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Public InboundMessagePage payload returned by the API." }, "InviteAccountUserRequest": { "required": [ "emailAddress", "firstName", "lastName", "role" ], "type": "object", "properties": { "firstName": { "maxLength": 100, "minLength": 0, "type": "string" }, "lastName": { "maxLength": 100, "minLength": 0, "type": "string" }, "emailAddress": { "maxLength": 320, "minLength": 0, "type": "string", "format": "email" }, "role": { "$ref": "#/components/schemas/UserRoleEntity" } }, "additionalProperties": false }, "Invoice": { "title": "Invoice", "type": "object", "properties": { "invoiceId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "invoiceNumber": { "type": "string", "nullable": true }, "periodStart": { "type": "string", "format": "date-time" }, "periodEnd": { "type": "string", "format": "date-time" }, "subtotalUsd": { "type": "number", "format": "double" }, "taxUsd": { "type": "number", "format": "double" }, "totalUsd": { "type": "number", "format": "double" }, "paidUsd": { "type": "number", "format": "double" }, "balanceUsd": { "type": "number", "format": "double" }, "taxRate": { "type": "number", "format": "double", "nullable": true }, "taxJurisdiction": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/InvoiceStatusEntity" }, "paidAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "emailedAt": { "type": "string", "format": "date-time", "nullable": true }, "emailStatus": { "$ref": "#/components/schemas/InvoiceEmailStatusEntity" }, "creditNotes": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceCreditNote" }, "nullable": true } }, "additionalProperties": false, "description": "Public Invoice payload returned by the API." }, "InvoiceCreditNote": { "title": "InvoiceCreditNote", "type": "object", "properties": { "invoiceCreditNoteId": { "type": "string", "format": "uuid" }, "amountUsd": { "type": "number", "format": "double" }, "description": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Public InvoiceCreditNote payload returned by the API." }, "InvoiceEmailStatusEntity": { "enum": [ "NotSent", "Sent", "Failed" ], "type": "string", "x-internal": true }, "InvoiceLine": { "title": "InvoiceLine", "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "format": "int32" }, "unitPriceUsd": { "type": "number", "format": "double" }, "amountUsd": { "type": "number", "format": "double" }, "occurredAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Public InvoiceLine payload returned by the API." }, "InvoiceStatusEntity": { "enum": [ "Draft", "Issued", "PartiallyPaid", "Paid", "Overdue", "Voided" ], "type": "string", "x-internal": true }, "IssueRequest": { "type": "object", "properties": { "purpose": { "$ref": "#/components/schemas/EmailOtpPurposeEntity" }, "action": { "$ref": "#/components/schemas/StepUpAction" } }, "additionalProperties": false, "description": "Request to issue a new email OTP challenge for the current user." }, "KycDocument": { "title": "KycDocument", "type": "object", "properties": { "kycDocumentId": { "type": "string", "format": "uuid" }, "documentType": { "type": "string", "nullable": true }, "originalFileName": { "type": "string", "nullable": true }, "contentType": { "type": "string", "nullable": true }, "length": { "type": "integer", "format": "int64" }, "status": { "$ref": "#/components/schemas/KycDocumentStatusEntity" }, "uploadedAt": { "type": "string", "format": "date-time" }, "reviewedAt": { "type": "string", "format": "date-time", "nullable": true }, "rejectionReason": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Public KycDocument payload returned by the API." }, "KycDocumentStatusEntity": { "enum": [ "PendingReview", "Approved", "Rejected" ], "type": "string", "x-internal": true }, "LinkProviderRequest": { "type": "object", "properties": { "providerId": { "type": "string", "format": "uuid" }, "code": { "type": "string", "nullable": true }, "codeVerifier": { "type": "string", "nullable": true }, "redirectUri": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LoginStatistics": { "type": "object", "properties": { "totalAttempts": { "type": "integer", "format": "int32" }, "successfulLogins": { "type": "integer", "format": "int32" }, "failedLogins": { "type": "integer", "format": "int32" }, "lastSuccessfulLogin": { "type": "string", "format": "date-time", "nullable": true }, "lastFailedLogin": { "type": "string", "format": "date-time", "nullable": true }, "recentFailedAttempts": { "type": "integer", "format": "int32" }, "isAccountLocked": { "type": "boolean" }, "timeUntilUnlock": { "type": "string", "format": "date-span", "nullable": true } }, "additionalProperties": false }, "Message": { "title": "Message", "type": "object", "properties": { "messageId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "account": { "$ref": "#/components/schemas/Account" }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "channelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "destination": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "messageType": { "$ref": "#/components/schemas/MessageTypeEntity" }, "currentState": { "$ref": "#/components/schemas/MessageStateEntity" }, "createdAt": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte", "nullable": true }, "latestVersion": { "$ref": "#/components/schemas/MessageVersion" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/MessageVersion" }, "nullable": true }, "pushTopics": { "type": "array", "items": { "type": "string" }, "nullable": true }, "pushUserIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "adaptiveRiskParticipated": { "type": "boolean" }, "adaptiveRiskExplanationBucket": { "type": "string", "nullable": true }, "channelHistory": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannel" }, "nullable": true }, "messageTemplateId": { "type": "string", "format": "uuid", "nullable": true }, "clientReference": { "type": "string", "nullable": true }, "replyStatus": { "$ref": "#/components/schemas/ReplyStatusEntity" }, "replyOptionKey": { "type": "string", "nullable": true }, "replyOptionValue": { "type": "string", "nullable": true }, "answeredAt": { "type": "string", "format": "date-time", "nullable": true }, "sendAt": { "type": "string", "format": "date-time", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "priority": { "$ref": "#/components/schemas/DispatchPriorityEntity" } }, "additionalProperties": false, "description": "Public Message payload returned by the API." }, "MessageChannel": { "title": "MessageChannel", "type": "object", "properties": { "messageChannelId": { "type": "string", "format": "uuid" }, "channelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "providerName": { "type": "string", "nullable": true }, "attemptCount": { "type": "integer", "format": "int32" }, "wasFallback": { "type": "boolean" }, "providerMessageId": { "type": "string", "nullable": true }, "providerStatus": { "type": "string", "nullable": true }, "deliveryStatus": { "$ref": "#/components/schemas/MessageChannelDeliveryStatusEntity" }, "createdAt": { "type": "string", "format": "date-time" }, "sentAt": { "type": "string", "format": "date-time", "nullable": true }, "deliveredAt": { "type": "string", "format": "date-time", "nullable": true }, "failedAt": { "type": "string", "format": "date-time", "nullable": true }, "failureReason": { "type": "string", "nullable": true }, "errorCategory": { "$ref": "#/components/schemas/SendErrorCategoryEntity" }, "fromAddress": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Public MessageChannel payload returned by the API." }, "MessageChannelDeliveryStatusEntity": { "enum": [ "Pending", "Sent", "Delivered", "Failed", "Undelivered" ], "type": "string", "x-internal": true }, "MessageCostDetail": { "title": "MessageCostDetail", "type": "object", "properties": { "messageCostId": { "type": "string", "format": "uuid" }, "messageId": { "type": "string", "format": "uuid" }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "subaccountName": { "type": "string", "nullable": true }, "carrierName": { "type": "string", "nullable": true }, "customerChargeUsd": { "type": "number", "format": "double" }, "createdAt": { "type": "string", "format": "date-time" }, "channelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "attemptNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Public MessageCostDetail payload returned by the API." }, "MessageCostSummary": { "title": "MessageCostSummary", "type": "object", "properties": { "totalMessages": { "type": "integer", "format": "int32" }, "totalCarrierCostUsd": { "type": "number", "format": "double" }, "totalCustomerChargeUsd": { "type": "number", "format": "double" }, "totalMarginUsd": { "type": "number", "format": "double" }, "marginPercent": { "type": "number", "format": "double" }, "periodStart": { "type": "string", "format": "date-time" }, "periodEnd": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Public MessageCostSummary payload returned by the API." }, "MessageRiskResponse": { "type": "object", "properties": { "outcome": { "type": "string", "nullable": true }, "explanation": { "type": "string", "nullable": true }, "isShadowDecision": { "type": "boolean" }, "evaluatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Risk decision summary returned to authenticated account owners." }, "MessageStateAudit": { "title": "MessageStateAudit", "type": "object", "properties": { "fromState": { "$ref": "#/components/schemas/MessageStateEntity" }, "toState": { "$ref": "#/components/schemas/MessageStateEntity" }, "reason": { "type": "string", "nullable": true }, "actor": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "auditType": { "$ref": "#/components/schemas/AuditTypeEntity" }, "versionNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Public MessageStateAudit payload returned by the API." }, "MessageStateEntity": { "enum": [ "Created", "Validated", "ContextResolved", "ComplianceEvaluated", "Queued", "Submitted", "Accepted", "Delivered", "HeldForReview", "RejectedValidation", "RejectedContext", "RejectedCompliance", "RejectedUpstream", "FailedDelivery", "SuspendedCustomer", "SuspendedCampaign", "DeadLettered", "Deleted", "DispatchHeld", "Scheduled", "Canceled", "Expired" ], "type": "string", "x-internal": true }, "MessageTemplate": { "title": "MessageTemplate", "type": "object", "properties": { "messageTemplateId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "channelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "bodyTemplate": { "type": "string", "nullable": true }, "defaultVariables": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "variables": { "type": "array", "items": { "type": "string" }, "nullable": true }, "replyOptions": { "type": "array", "items": { "$ref": "#/components/schemas/ReplyOption" }, "nullable": true }, "isActive": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "createdBy": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Public MessageTemplate payload returned by the API." }, "MessageTypeEntity": { "enum": [ "Transactional", "Marketing", "Compliance", "System", "Other" ], "type": "string", "x-internal": true }, "MessageVersion": { "title": "MessageVersion", "type": "object", "properties": { "messageState": { "$ref": "#/components/schemas/MessageStateEntity" }, "tryCount": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "nextRetryAt": { "type": "string", "format": "date-time", "nullable": true }, "versionNumber": { "type": "integer", "format": "int32" }, "audits": { "type": "array", "items": { "$ref": "#/components/schemas/MessageStateAudit" }, "nullable": true } }, "additionalProperties": false, "description": "Public MessageVersion payload returned by the API." }, "MfaStepUpRequest": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/StepUpAction" }, "method": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "webAuthnChallengeId": { "type": "string", "format": "uuid", "nullable": true }, "assertion": { "nullable": true } }, "additionalProperties": false }, "MfaStepUpResponse": { "type": "object", "properties": { "stepUpToken": { "type": "string", "nullable": true }, "stepUpExpiresAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "NumberPool": { "title": "NumberPool", "type": "object", "properties": { "poolId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "strategy": { "$ref": "#/components/schemas/PoolSelectionStrategyEntity" }, "isActive": { "type": "boolean" }, "numberCount": { "type": "integer", "format": "int32" }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Public NumberPool payload returned by the API." }, "OAuth2CallbackRequest": { "type": "object", "properties": { "code": { "type": "string", "description": "Authorization code from OAuth2 provider.", "nullable": true }, "state": { "type": "string", "description": "CSRF protection state (must match the one sent in authorize request).", "nullable": true }, "codeVerifier": { "type": "string", "description": "PKCE code verifier (43-128 characters).", "nullable": true }, "providerType": { "type": "string", "description": "Provider type (\"Google\", \"Microsoft\", \"OIDC\").", "nullable": true }, "error": { "type": "string", "description": "Error code if authorization failed.", "nullable": true }, "errorDescription": { "type": "string", "description": "Error description if authorization failed.", "nullable": true } }, "additionalProperties": false, "description": "Request to handle OAuth2 provider callback." }, "OAuth2CallbackResponse": { "type": "object", "properties": { "isSuccess": { "type": "boolean", "description": "Whether callback was successfully processed." }, "userId": { "type": "string", "description": "Authenticated user ID (if successful).", "format": "uuid", "nullable": true }, "isNewUser": { "type": "boolean", "description": "Whether this is a new user (first-time OAuth login)." }, "identity": { "$ref": "#/components/schemas/ExternalIdentityResponse" }, "errorMessage": { "type": "string", "description": "Error message if callback failed.", "nullable": true } }, "additionalProperties": false, "description": "Response after handling OAuth2 callback." }, "OnboardingResponse": { "type": "object", "properties": { "connectedAccountId": { "type": "string", "description": "Masked identifier of the payout account created for the account.", "nullable": true }, "onboardingUrl": { "type": "string", "description": "URL to the onboarding flow for this payout account.", "nullable": true } }, "additionalProperties": false, "description": "Response for onboarding creation" }, "OnboardingStatusResponse": { "type": "object", "properties": { "isComplete": { "type": "boolean", "description": "True when the payout account can accept charges." }, "hasConnectedAccount": { "type": "boolean", "description": "True once a payout account exists for this Account." }, "chargesEnabled": { "type": "boolean", "description": "Whether the payout account can accept charges." }, "payoutsEnabled": { "type": "boolean", "description": "Whether payouts are enabled on the payout account." }, "detailsSubmitted": { "type": "boolean", "description": "True once the onboarding submission has been accepted (verification may still be pending)." }, "isAccountAccessible": { "type": "boolean", "description": "Whether the stored payout account was retrieved successfully." }, "connectedAccountId": { "type": "string", "description": "Masked payout account identifier.", "nullable": true }, "businessName": { "type": "string", "description": "Business profile name when available.", "nullable": true }, "country": { "type": "string", "description": "Payout account country.", "nullable": true }, "currency": { "type": "string", "description": "Payout account settlement currency.", "nullable": true }, "businessType": { "type": "string", "description": "Payout account business type.", "nullable": true }, "cardPaymentsEnabled": { "type": "boolean", "description": "Whether the card payments capability is active." }, "transfersEnabled": { "type": "boolean", "description": "Whether the transfers capability is active." }, "canUpdateDetails": { "type": "boolean", "description": "Whether an account-update session can be opened." }, "canOpenExpressDashboard": { "type": "boolean", "description": "Whether a payout account dashboard session can be opened." }, "isRestricted": { "type": "boolean", "description": "Whether the payment processor has restricted the account." }, "currentlyDue": { "type": "array", "items": { "type": "string" }, "description": "Verification items currently blocking the account.", "nullable": true }, "eventuallyDue": { "type": "array", "items": { "type": "string" }, "description": "Verification items that will be required later.", "nullable": true }, "pastDue": { "type": "array", "items": { "type": "string" }, "description": "Verification items that are overdue.", "nullable": true } }, "additionalProperties": false, "description": "Response for onboarding status check" }, "OpenInvoiceDue": { "title": "OpenInvoiceDue", "type": "object", "properties": { "invoiceId": { "type": "string", "format": "uuid" }, "invoiceNumber": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/InvoiceStatusEntity" }, "amountDueUsd": { "type": "number", "format": "double" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Public OpenInvoiceDue payload returned by the API." }, "OptInEvidence": { "title": "OptInEvidence", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "phoneNumber": { "type": "string", "nullable": true }, "method": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "consentLanguage": { "type": "string", "nullable": true }, "optedInAt": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "revokedAt": { "type": "string", "format": "date-time", "nullable": true }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Public OptInEvidence payload returned by the API." }, "OptInEvidencePage": { "title": "OptInEvidencePage", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OptInEvidence" }, "nullable": true }, "nextCursor": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Public OptInEvidencePage payload returned by the API." }, "OutstandingInvoiceSummary": { "title": "OutstandingInvoiceSummary", "type": "object", "properties": { "openInvoiceCount": { "type": "integer", "format": "int32" }, "openInvoiceGrossUsd": { "type": "number", "format": "double" }, "appliedPaymentsUsd": { "type": "number", "format": "double" }, "netOutstandingUsd": { "type": "number", "format": "double" } }, "additionalProperties": false, "description": "Public OutstandingInvoiceSummary payload returned by the API." }, "PasskeyListResponse": { "type": "object", "properties": { "passkeys": { "type": "array", "items": { "$ref": "#/components/schemas/PasskeyResponse" }, "nullable": true } }, "additionalProperties": false }, "PasskeyResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "nickname": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "lastUsedAt": { "type": "string", "format": "date-time", "nullable": true }, "discoverable": { "type": "boolean" } }, "additionalProperties": false }, "PaymentMethod": { "title": "PaymentMethod", "type": "object", "properties": { "paymentMethodId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid", "nullable": true }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "namespace": { "$ref": "#/components/schemas/PaymentMethodNamespaceEntity" }, "cardBrand": { "type": "string", "nullable": true }, "last4": { "type": "string", "nullable": true }, "expirationMonth": { "type": "integer", "format": "int32" }, "expirationYear": { "type": "integer", "format": "int32" }, "isDefault": { "type": "boolean" }, "isExpired": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Public PaymentMethod payload returned by the API." }, "PaymentMethodNamespaceEntity": { "enum": [ "Platform", "Connected" ], "type": "string", "x-internal": true }, "PayoutAccountLinkResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "Short-lived hosted URL.", "nullable": true } }, "additionalProperties": false, "description": "Response containing a short-lived hosted management URL." }, "PhoneNumberCapabilityEntity": { "enum": [ "None", "Sms", "Mms", "Voice" ], "type": "string", "x-internal": true }, "PhoneNumberStatusEntity": { "enum": [ "Active", "Suspended", "Porting", "Released" ], "type": "string", "x-internal": true }, "PhoneNumberTypeEntity": { "enum": [ "LongCode", "TollFree", "ShortCode" ], "type": "string", "x-internal": true }, "PlanChangePreview": { "title": "PlanChangePreview", "type": "object", "properties": { "currentPlanName": { "type": "string", "nullable": true }, "newPlanName": { "type": "string", "nullable": true }, "currentMonthlyPrice": { "type": "number", "format": "double" }, "newMonthlyPrice": { "type": "number", "format": "double" }, "unusedCreditUsd": { "type": "number", "format": "double" }, "newPlanChargeUsd": { "type": "number", "format": "double" }, "netAmountUsd": { "type": "number", "format": "double" }, "remainingDays": { "type": "integer", "format": "int32" }, "effectiveDate": { "type": "string", "format": "date-time" }, "nextBillingDate": { "type": "string", "format": "date-time" }, "isUpgrade": { "type": "boolean" }, "isDueNow": { "type": "boolean" } }, "additionalProperties": false, "description": "Public PlanChangePreview payload returned by the API." }, "PoolSelectionStrategyEntity": { "enum": [ "RoundRobin", "Random", "LeastUsed", "Sticky" ], "type": "string", "x-internal": true }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ProvisionedPhoneNumber": { "title": "ProvisionedPhoneNumber", "type": "object", "properties": { "phoneNumberId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "e164Number": { "type": "string", "nullable": true }, "numberType": { "$ref": "#/components/schemas/PhoneNumberTypeEntity" }, "status": { "$ref": "#/components/schemas/PhoneNumberStatusEntity" }, "capabilities": { "$ref": "#/components/schemas/PhoneNumberCapabilityEntity" }, "isDefault": { "type": "boolean" }, "isPooled": { "type": "boolean" }, "poolId": { "type": "string", "format": "uuid", "nullable": true }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "subaccountName": { "type": "string", "nullable": true }, "monthlyFeeCents": { "type": "integer", "format": "int32" }, "purchasedAt": { "type": "string", "format": "date-time" }, "tenDlcCampaignId": { "type": "string", "format": "uuid", "nullable": true }, "tenDlcCarrierCampaignId": { "type": "string", "nullable": true }, "campaignAssignmentStatus": { "$ref": "#/components/schemas/TenDlcCampaignAssignmentStatusEntity" }, "campaignAssignmentFailureReason": { "type": "string", "nullable": true }, "campaignAssignmentRequestedAt": { "type": "string", "format": "date-time", "nullable": true }, "campaignAssignmentUpdatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Public ProvisionedPhoneNumber payload returned by the API." }, "PublicExternalAuthProviderResponse": { "type": "object", "properties": { "providerId": { "type": "string", "description": "Unique provider identifier.", "format": "uuid" }, "providerType": { "type": "string", "description": "Provider type identifier.", "nullable": true }, "displayName": { "type": "string", "description": "Display name shown to end users.", "nullable": true } }, "additionalProperties": false, "description": "Public metadata for an external authentication provider." }, "PublicRegistrationPaymentConfig": { "type": "object", "properties": { "publishableKey": { "type": "string", "description": "Public key the client-side card form is initialised with.", "nullable": true } }, "additionalProperties": false, "description": "Public configuration the registration page needs to show the payment form." }, "PublicRegistrationPaymentDiagnostics": { "type": "object", "properties": { "environment": { "type": "string", "description": "ASP.NET Core environment name (Development, Staging, Production).", "nullable": true }, "hasPublishableKey": { "type": "boolean", "description": "Indicates whether a publishable key is configured." }, "publishableKeyPrefix": { "type": "string", "description": "Leading characters of the publishable key for sanity checking.", "nullable": true }, "publishableKeyMode": { "type": "string", "description": "Whether the publishable key is in test or live mode.", "nullable": true }, "hasSecretKey": { "type": "boolean", "description": "Indicates whether a secret key is configured." }, "secretKeyPrefix": { "type": "string", "description": "Leading characters of the secret key for sanity checking.", "nullable": true }, "secretKeyMode": { "type": "string", "description": "Whether the secret key is in test or live mode.", "nullable": true }, "keyModeMatch": { "type": "boolean", "description": "True when both keys are in the same mode (both test or both live)." }, "currency": { "type": "string", "description": "Configured currency code.", "nullable": true } }, "additionalProperties": false, "description": "Development-only payment key diagnostics returned by the payment-diagnostics endpoint." }, "PublicRegistrationResult": { "type": "object", "properties": { "accountId": { "type": "string", "description": "Newly created account ID.", "format": "uuid" }, "ownerUserId": { "type": "string", "description": "User ID of the account owner.", "format": "uuid" }, "ownerEmail": { "type": "string", "description": "Email address of the account owner.", "nullable": true }, "accountName": { "type": "string", "description": "Display name of the registered account.", "nullable": true }, "message": { "type": "string", "description": "Human-readable confirmation message.", "nullable": true } }, "additionalProperties": false, "description": "Response returned after a successful public account registration." }, "PurchasePhoneNumberRequest": { "type": "object", "properties": { "e164Number": { "type": "string", "nullable": true }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "countryCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "QuotaUnitEntity": { "enum": [ "PerMessage", "PerSegment" ], "type": "string", "x-internal": true }, "RealtimeMetrics": { "title": "RealtimeMetrics", "type": "object", "properties": { "realtimeMetricId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid", "nullable": true }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "accountName": { "type": "string", "nullable": true }, "snapshotTimeUtc": { "type": "string", "format": "date-time" }, "messagesSent": { "type": "integer", "format": "int32" }, "messagesDelivered": { "type": "integer", "format": "int32" }, "messagesFailed": { "type": "integer", "format": "int32" }, "messagesPending": { "type": "integer", "format": "int32" }, "messagesRejected": { "type": "integer", "format": "int32" }, "messagesHeld": { "type": "integer", "format": "int32" }, "deliveryRate": { "type": "number", "format": "double" }, "activeConnections": { "type": "integer", "format": "int32" }, "queueDepth": { "type": "integer", "format": "int32" }, "averageLatencyMs": { "type": "number", "format": "double" }, "throughputPerSecond": { "type": "number", "format": "double" } }, "additionalProperties": false, "description": "Public RealtimeMetrics payload returned by the API." }, "RealtimeMetricsHealth": { "title": "RealtimeMetricsHealth", "type": "object", "properties": { "isHealthy": { "type": "boolean" }, "lastUpdateUtc": { "type": "string", "format": "date-time" }, "totalMetricsTracked": { "type": "integer", "format": "int32" }, "activeAccounts": { "type": "integer", "format": "int32" }, "activeSubaccounts": { "type": "integer", "format": "int32" }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Public RealtimeMetricsHealth payload returned by the API." }, "Receipt": { "title": "Receipt", "type": "object", "properties": { "receiptId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "invoiceId": { "type": "string", "format": "uuid" }, "invoiceNumber": { "type": "string", "nullable": true }, "receiptNumber": { "type": "string", "nullable": true }, "externalPaymentId": { "type": "string", "nullable": true }, "amountUsd": { "type": "number", "format": "double" }, "taxUsd": { "type": "number", "format": "double" }, "totalUsd": { "type": "number", "format": "double" }, "paidAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Public Receipt payload returned by the API." }, "RecipientChannelPreference": { "title": "RecipientChannelPreference", "type": "object", "properties": { "channelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "isOptedOut": { "type": "boolean" }, "isAccountWide": { "type": "boolean" }, "optedOutAt": { "type": "string", "format": "date-time", "nullable": true }, "canResubscribe": { "type": "boolean" } }, "additionalProperties": false, "description": "Public RecipientChannelPreference payload returned by the API." }, "RecipientOptOut": { "title": "RecipientOptOut", "type": "object", "properties": { "recipient": { "type": "string", "nullable": true }, "channelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "source": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true }, "optedOutAt": { "type": "string", "format": "date-time" }, "optedInAt": { "type": "string", "format": "date-time", "nullable": true }, "isOptedOut": { "type": "boolean" }, "isAccountWide": { "type": "boolean" }, "canResubscribe": { "type": "boolean" }, "scope": { "type": "string", "nullable": true }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Public RecipientOptOut payload returned by the API." }, "RecipientPreferences": { "title": "RecipientPreferences", "type": "object", "properties": { "recipient": { "type": "string", "nullable": true }, "channels": { "type": "array", "items": { "$ref": "#/components/schemas/RecipientChannelPreference" }, "nullable": true } }, "additionalProperties": false, "description": "Public RecipientPreferences payload returned by the API." }, "RecordAccountRecipientOptOutRequest": { "required": [ "channelType", "recipient", "scope" ], "type": "object", "properties": { "recipient": { "maxLength": 320, "minLength": 1, "type": "string" }, "channelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "scope": { "$ref": "#/components/schemas/AccountOptOutScopeChoice" }, "reason": { "maxLength": 500, "type": "string", "nullable": true } }, "additionalProperties": false }, "RecordOptInEvidenceRequest": { "required": [ "method", "optedInAt", "phoneNumber" ], "type": "object", "properties": { "phoneNumber": { "maxLength": 32, "minLength": 1, "type": "string" }, "method": { "maxLength": 100, "minLength": 1, "type": "string" }, "optedInAt": { "type": "string", "format": "date-time" }, "source": { "maxLength": 500, "type": "string", "nullable": true }, "consentLanguage": { "maxLength": 2000, "type": "string", "nullable": true } }, "additionalProperties": false }, "RecordRecipientOptInRequest": { "required": [ "channelType", "consentEvidence", "consentMethod", "recipient" ], "type": "object", "properties": { "recipient": { "maxLength": 320, "minLength": 1, "type": "string" }, "channelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "consentConfirmed": { "type": "boolean" }, "consentMethod": { "maxLength": 32, "minLength": 1, "type": "string" }, "consentEvidence": { "maxLength": 1000, "minLength": 1, "type": "string" }, "consentObtainedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "RecordRecipientOptOutRequest": { "required": [ "channelType", "recipient" ], "type": "object", "properties": { "recipient": { "maxLength": 320, "minLength": 1, "type": "string" }, "channelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "reason": { "maxLength": 500, "type": "string", "nullable": true } }, "additionalProperties": false }, "RefreshTokenRequest": { "type": "object", "properties": { "refreshToken": { "type": "string", "description": "The refresh token to exchange for new access and refresh tokens.", "nullable": true } }, "additionalProperties": false, "description": "Request to refresh tokens" }, "RegisterTenDlcBrandRequest": { "type": "object", "properties": { "legalName": { "type": "string", "nullable": true }, "ein": { "type": "string", "nullable": true }, "brandType": { "$ref": "#/components/schemas/TenDlcBrandTypeEntity" }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "vertical": { "$ref": "#/components/schemas/TenDlcVerticalEntity" }, "stockSymbol": { "type": "string", "nullable": true }, "stockExchange": { "type": "string", "nullable": true }, "altBusinessId": { "type": "string", "nullable": true }, "altBusinessIdType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RenderTemplateRequest": { "type": "object", "properties": { "variables": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ReopenSupportCaseRequest": { "type": "object", "properties": { "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReplyOption": { "title": "ReplyOption", "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "aliases": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "description": "Public ReplyOption payload returned by the API." }, "ReplyStatusEntity": { "enum": [ "None", "Awaiting", "Answered", "Expired" ], "type": "string", "x-internal": true }, "RequestEmailChangeRequest": { "required": [ "currentPassword", "newEmailAddress" ], "type": "object", "properties": { "newEmailAddress": { "maxLength": 320, "minLength": 0, "type": "string", "format": "email" }, "currentPassword": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "ResetUserPasswordRequest": { "required": [ "newPassword", "token" ], "type": "object", "properties": { "token": { "minLength": 1, "type": "string" }, "newPassword": { "maxLength": 128, "minLength": 12, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[^A-Za-z0-9]).{12,}$", "type": "string" } }, "additionalProperties": false }, "RevokeTokenRequest": { "type": "object", "properties": { "refreshToken": { "type": "string", "description": "Optional refresh token to revoke; if omitted, the current user's tokens are revoked.", "nullable": true } }, "additionalProperties": false, "description": "Request to revoke a token" }, "RiskSignal": { "title": "RiskSignal", "type": "object", "properties": { "riskSignalId": { "type": "string", "format": "uuid" }, "adaptiveRiskEvaluationId": { "type": "string", "format": "uuid" }, "signalType": { "type": "string", "nullable": true }, "scoreContribution": { "type": "number", "format": "double" }, "confidence": { "type": "number", "format": "double" }, "reason": { "type": "string", "nullable": true }, "rawData": { "type": "string", "nullable": true }, "sourceProvider": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Public RiskSignal payload returned by the API." }, "RiskSignalSummary": { "title": "RiskSignalSummary", "type": "object", "properties": { "totalSignalsCollected": { "type": "integer", "format": "int32" }, "maxScoreContribution": { "type": "number", "format": "double" }, "averageConfidence": { "type": "number", "format": "double" }, "signalCountByType": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "signalCountByProvider": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "highestContributingSignals": { "type": "array", "items": { "$ref": "#/components/schemas/RiskSignal" }, "nullable": true } }, "additionalProperties": false, "description": "Public RiskSignalSummary payload returned by the API." }, "RiskSignalTypeEntity": { "enum": [ "ContentToxicity", "SenderReputation", "DomainReputation", "UrlSafety", "SpammerPattern", "HeaderAnomaly", "RecipientComplaintHistory", "MessageFormatAnomaly", "AuthenticationFailure", "GeographicAnomaly", "TemporalAnomaly" ], "type": "string", "x-internal": true }, "SavePaymentMethodRequest": { "type": "object", "properties": { "externalPaymentMethodId": { "type": "string", "nullable": true }, "setAsDefault": { "type": "boolean" } }, "additionalProperties": false }, "SegmentPreviewRequest": { "type": "object", "properties": { "body": { "type": "string", "description": "Message body to evaluate.", "nullable": true }, "mediaType": { "$ref": "#/components/schemas/ContentFormatEntity" }, "smartEncoding": { "type": "boolean", "description": "When true, smart-encoding normalization is applied before calculating segments.", "nullable": true } }, "additionalProperties": false, "description": "Request body for the segment preview endpoint." }, "SegmentPreviewResponse": { "type": "object", "properties": { "encoding": { "type": "string", "description": "Detected or applied encoding (e.g. GSM7, UCS2).", "nullable": true }, "charCount": { "type": "integer", "description": "Total character count in the evaluated body.", "format": "int32" }, "segmentCount": { "type": "integer", "description": "Number of SMS segments the body will occupy.", "format": "int32" }, "estimatedCarrierCostUsd": { "type": "number", "description": "Estimated carrier cost in USD for the calculated segment count.", "format": "double" }, "estimatedCustomerChargeUsd": { "type": "number", "description": "Estimated customer charge in USD based on the active subscription plan; null when no plan is active.", "format": "double", "nullable": true }, "normalizedBody": { "type": "string", "description": "Smart-encoding normalized body; null when smart encoding was not requested.", "nullable": true } }, "additionalProperties": false, "description": "Segment analysis result returned by the preview endpoint." }, "SendErrorCategoryEntity": { "enum": [ "None", "RecipientValidation", "Consent", "ChannelConfiguration", "ProviderError", "QuotaExceeded", "Platform", "ProviderPaused" ], "type": "string", "x-internal": true }, "SetPrimaryIdentityRequest": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "identityId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "SetupIntent": { "title": "SetupIntent", "type": "object", "properties": { "setupIntentId": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "publishableKey": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Public SetupIntent payload returned by the API." }, "StepUpAction": { "enum": [ "ChangePassword", "ChangeEmail", "PaymentMethod", "RevokeSession", "ApiKey", "BillingChange", "AccountHardDelete", "UnlinkIdentity", "MfaManage", "UserMfaReset", "StaffMfaReset", "AccountSecurityPolicy" ], "type": "string" }, "Subaccount": { "title": "Subaccount", "type": "object", "properties": { "subaccountId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/SubaccountStatusEntity" }, "isolationRules": { "type": "string", "nullable": true }, "isDeleted": { "type": "boolean" }, "externalCustomerId": { "type": "string", "nullable": true }, "defaultPaymentMethodId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Public Subaccount payload returned by the API." }, "SubaccountChargeResult": { "required": [ "amountMinor", "applicationFeeAmountMinor", "currency", "paymentIntentId", "status", "subaccountPaymentEventId" ], "type": "object", "properties": { "subaccountPaymentEventId": { "type": "string", "format": "uuid" }, "paymentIntentId": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/SubaccountPaymentEventStatusEntity" }, "amountMinor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "nullable": true }, "applicationFeeAmountMinor": { "type": "integer", "format": "int64" }, "failureCode": { "type": "string", "nullable": true }, "failureMessage": { "type": "string", "nullable": true }, "refundId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SubaccountPaymentEvent": { "title": "SubaccountPaymentEvent", "type": "object", "properties": { "subaccountPaymentEventId": { "type": "string", "format": "uuid" }, "subaccountId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "externalPaymentId": { "type": "string", "nullable": true }, "connectedAccountId": { "type": "string", "nullable": true }, "amountMinor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "nullable": true }, "applicationFeeAmountMinor": { "type": "integer", "format": "int64" }, "status": { "$ref": "#/components/schemas/SubaccountPaymentEventStatusEntity" }, "failureCode": { "type": "string", "nullable": true }, "failureMessage": { "type": "string", "nullable": true }, "occurredAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Public SubaccountPaymentEvent payload returned by the API." }, "SubaccountPaymentEventStatusEntity": { "enum": [ "Pending", "Succeeded", "Failed", "Refunded", "PartiallyRefunded" ], "type": "string", "x-internal": true }, "SubaccountQuota": { "title": "SubaccountQuota", "type": "object", "properties": { "subaccountQuotaId": { "type": "string", "format": "uuid" }, "subaccountId": { "type": "string", "format": "uuid" }, "dailyLimit": { "type": "integer", "format": "int32", "nullable": true }, "monthlyLimit": { "type": "integer", "format": "int32", "nullable": true }, "ratePerSecond": { "type": "integer", "format": "int32", "nullable": true }, "ratePerMinute": { "type": "integer", "format": "int32", "nullable": true }, "dailyUsed": { "type": "integer", "format": "int32" }, "monthlyUsed": { "type": "integer", "format": "int32" }, "dailyRemaining": { "type": "integer", "format": "int32", "nullable": true }, "monthlyRemaining": { "type": "integer", "format": "int32", "nullable": true }, "lastDailyReset": { "type": "string", "format": "date-time" }, "lastMonthlyReset": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Public SubaccountQuota payload returned by the API." }, "SubaccountSetupIntent": { "title": "SubaccountSetupIntent", "type": "object", "properties": { "setupIntentId": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "publishableKey": { "type": "string", "nullable": true }, "connectedAccountId": { "type": "string", "nullable": true }, "externalCustomerId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Public SubaccountSetupIntent payload returned by the API." }, "SubaccountStatusEntity": { "enum": [ "Active", "Suspended", "Closed", "Archived" ], "type": "string", "x-internal": true }, "SubscriptionPlan": { "title": "SubscriptionPlan", "type": "object", "properties": { "planId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "monthlyPriceUsd": { "type": "number", "format": "double" }, "annualPriceUsd": { "type": "number", "format": "double", "nullable": true }, "smsBaseMessagePriceUsd": { "type": "number", "format": "double", "nullable": true }, "inboundSmsRate": { "type": "number", "format": "double", "nullable": true }, "smsOveragePerMessageUsd": { "type": "number", "format": "double", "nullable": true }, "mmsBaseMessagePriceUsd": { "type": "number", "format": "double", "nullable": true }, "inboundMmsRate": { "type": "number", "format": "double", "nullable": true }, "mmsOveragePerMessageUsd": { "type": "number", "format": "double", "nullable": true }, "carrierSurchargePassThrough": { "type": "boolean" }, "platformFeePercent": { "type": "number", "format": "double" }, "phoneNumberSetupRate": { "type": "number", "format": "double", "nullable": true }, "phoneNumberMonthlyRate": { "type": "number", "format": "double", "nullable": true }, "tenDlcBrandRegistrationFee": { "type": "number", "format": "double", "nullable": true }, "tenDlcCampaignRegistrationFee": { "type": "number", "format": "double", "nullable": true }, "tenDlcLowVolumeCampaignRegistrationFee": { "type": "number", "format": "double", "nullable": true }, "tenDlcSpecialCampaignRegistrationFee": { "type": "number", "format": "double", "nullable": true }, "tenDlcPoliticalCampaignRegistrationFee": { "type": "number", "format": "double", "nullable": true }, "tenDlcSoleProprietorCampaignRegistrationFee": { "type": "number", "format": "double", "nullable": true }, "tenDlcCampaignMonthlyMaintenanceFee": { "type": "number", "format": "double", "nullable": true }, "tenDlcLowVolumeCampaignMonthlyMaintenanceFee": { "type": "number", "format": "double", "nullable": true }, "tenDlcSpecialCampaignMonthlyMaintenanceFee": { "type": "number", "format": "double", "nullable": true }, "tenDlcPoliticalCampaignMonthlyMaintenanceFee": { "type": "number", "format": "double", "nullable": true }, "tenDlcSoleProprietorCampaignMonthlyMaintenanceFee": { "type": "number", "format": "double", "nullable": true }, "tenDlcStandardVettingFee": { "type": "number", "format": "double", "nullable": true }, "tenDlcEnhancedVettingFee": { "type": "number", "format": "double", "nullable": true }, "tenDlcPoliticalVettingFee": { "type": "number", "format": "double", "nullable": true }, "tenDlcBrandAppealFee": { "type": "number", "format": "double", "nullable": true }, "tenDlcVettingAppealFee": { "type": "number", "format": "double", "nullable": true }, "tenDlcBrandResubmitFee": { "type": "number", "format": "double", "nullable": true }, "tenDlcCampaignResubmitFee": { "type": "number", "format": "double", "nullable": true }, "tenDlcNumberConnectivityFee": { "type": "number", "format": "double", "nullable": true }, "ratePerSecond": { "type": "integer", "format": "int32", "nullable": true }, "ratePerMinute": { "type": "integer", "format": "int32", "nullable": true }, "dailyMessageLimit": { "type": "integer", "format": "int32", "nullable": true }, "monthlyMessageLimit": { "type": "integer", "format": "int32", "nullable": true }, "maxSubaccounts": { "type": "integer", "format": "int32", "nullable": true }, "quotaUnit": { "$ref": "#/components/schemas/QuotaUnitEntity" }, "isActive": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Public SubscriptionPlan payload returned by the API." }, "SubscriptionStatusEntity": { "enum": [ "Active", "PastDue", "Cancelled", "Expired", "Trialing" ], "type": "string", "x-internal": true }, "SupportCase": { "title": "SupportCase", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "referenceNumber": { "type": "string", "nullable": true }, "accountId": { "type": "string", "format": "uuid" }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "createdByUserId": { "type": "string", "format": "uuid" }, "contactEmail": { "type": "string", "nullable": true }, "category": { "$ref": "#/components/schemas/SupportCaseCategoryEntity" }, "severity": { "$ref": "#/components/schemas/SupportCaseSeverityEntity" }, "status": { "$ref": "#/components/schemas/SupportCaseStatusEntity" }, "source": { "$ref": "#/components/schemas/SupportCaseSourceEntity" }, "subject": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "preferredContactMethod": { "$ref": "#/components/schemas/SupportContactMethodEntity" }, "correlationKey": { "type": "string", "nullable": true }, "relatedMessageId": { "type": "string", "format": "uuid", "nullable": true }, "relatedWebhookEndpointId": { "type": "string", "format": "uuid", "nullable": true }, "relatedRequestId": { "type": "string", "nullable": true }, "relatedComplianceIncidentId": { "type": "string", "format": "uuid", "nullable": true }, "metadataJson": { "type": "string", "nullable": true }, "assignedToStaffId": { "type": "string", "format": "uuid", "nullable": true }, "assignedAt": { "type": "string", "format": "date-time", "nullable": true }, "firstRespondedAt": { "type": "string", "format": "date-time", "nullable": true }, "resolvedByStaffId": { "type": "string", "format": "uuid", "nullable": true }, "resolvedAt": { "type": "string", "format": "date-time", "nullable": true }, "resolutionNotes": { "type": "string", "nullable": true }, "reopenCount": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "closedAt": { "type": "string", "format": "date-time", "nullable": true }, "wasDeduped": { "type": "boolean" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/SupportCaseComment" }, "nullable": true }, "statusHistory": { "type": "array", "items": { "$ref": "#/components/schemas/SupportCaseStatusHistory" }, "nullable": true } }, "additionalProperties": false, "description": "Public SupportCase payload returned by the API." }, "SupportCaseCategoryEntity": { "enum": [ "AccountAccess", "Billing", "MessagingDelivery", "WebhooksIntegrations", "PhoneNumbersTenDlc", "ApiDeveloper", "SecurityPrivacy", "Other" ], "type": "string", "x-internal": true }, "SupportCaseComment": { "title": "SupportCaseComment", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "supportCaseId": { "type": "string", "format": "uuid" }, "authorType": { "$ref": "#/components/schemas/SupportCommentAuthorTypeEntity" }, "authorUserId": { "type": "string", "format": "uuid", "nullable": true }, "authorStaffId": { "type": "string", "format": "uuid", "nullable": true }, "body": { "type": "string", "nullable": true }, "isInternal": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Public SupportCaseComment payload returned by the API." }, "SupportCaseListResult": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SupportCase" }, "nullable": true }, "totalCount": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SupportCaseSeverityEntity": { "enum": [ "Low", "Medium", "High", "Critical" ], "type": "string", "x-internal": true }, "SupportCaseSourceEntity": { "enum": [ "UserDashboard", "Api", "StaffCreated" ], "type": "string", "x-internal": true }, "SupportCaseStatusEntity": { "enum": [ "Open", "Assigned", "WaitingOnCustomer", "Escalated", "Resolved", "Closed", "Reopened" ], "type": "string", "x-internal": true }, "SupportCaseStatusHistory": { "title": "SupportCaseStatusHistory", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "supportCaseId": { "type": "string", "format": "uuid" }, "fromStatus": { "$ref": "#/components/schemas/SupportCaseStatusEntity" }, "toStatus": { "$ref": "#/components/schemas/SupportCaseStatusEntity" }, "changedByType": { "$ref": "#/components/schemas/SupportCommentAuthorTypeEntity" }, "changedById": { "type": "string", "format": "uuid", "nullable": true }, "notes": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Public SupportCaseStatusHistory payload returned by the API." }, "SupportCommentAuthorTypeEntity": { "enum": [ "User", "Staff", "System" ], "type": "string", "x-internal": true }, "SupportContactMethodEntity": { "enum": [ "Email" ], "type": "string", "x-internal": true }, "TcrCampaignMnoStatus": { "title": "TcrCampaignMnoStatus", "type": "object", "properties": { "mno": { "type": "string", "nullable": true }, "operationStatus": { "type": "string", "nullable": true }, "tpmLimit": { "type": "integer", "format": "int32", "nullable": true }, "brandTier": { "type": "string", "nullable": true }, "qualified": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "description": "Public TcrCampaignMnoStatus payload returned by the API." }, "TcrStatusEntity": { "enum": [ "NotSubmitted", "Pending", "Approved", "Failed", "Suspended", "Deleted", "Expired" ], "type": "string", "x-internal": true }, "TemplatePreviewRequest": { "required": [ "bodyTemplate" ], "type": "object", "properties": { "bodyTemplate": { "maxLength": 2000, "minLength": 1, "type": "string" }, "variables": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "TenDlcBrand": { "title": "TenDlcBrand", "type": "object", "properties": { "brandId": { "type": "string", "format": "uuid" }, "legalName": { "type": "string", "nullable": true }, "ein": { "type": "string", "nullable": true }, "brandType": { "$ref": "#/components/schemas/TenDlcBrandTypeEntity" }, "status": { "$ref": "#/components/schemas/TenDlcBrandStatusEntity" }, "failureReason": { "type": "string", "nullable": true }, "submittedAt": { "type": "string", "format": "date-time", "nullable": true }, "verifiedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "tcrBrandId": { "type": "string", "nullable": true }, "tcrStatus": { "$ref": "#/components/schemas/TcrStatusEntity" }, "tcrIdentityStatus": { "type": "string", "nullable": true }, "tcrVettingScore": { "type": "integer", "format": "int32", "nullable": true }, "tcrVettingClass": { "type": "string", "nullable": true }, "tcrFailureCode": { "type": "string", "nullable": true }, "tcrFailureReason": { "type": "string", "nullable": true }, "tcrSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "tcrLastSyncedAt": { "type": "string", "format": "date-time", "nullable": true }, "isLiveTcrData": { "type": "boolean" }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "vertical": { "$ref": "#/components/schemas/TenDlcVerticalEntity" }, "stockSymbol": { "type": "string", "nullable": true }, "stockExchange": { "type": "string", "nullable": true }, "altBusinessId": { "type": "string", "nullable": true }, "altBusinessIdType": { "type": "string", "nullable": true }, "accountId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Public TenDlcBrand payload returned by the API." }, "TenDlcBrandStatusEntity": { "enum": [ "Draft", "Submitted", "Pending", "Verified", "Failed" ], "type": "string", "x-internal": true }, "TenDlcBrandTypeEntity": { "enum": [ "PrivateProfit", "PublicProfit", "NonProfit", "Government", "SoleProprietor" ], "type": "string", "x-internal": true }, "TenDlcCampaign": { "title": "TenDlcCampaign", "type": "object", "properties": { "campaignId": { "type": "string", "format": "uuid" }, "brandId": { "type": "string", "format": "uuid" }, "useCase": { "$ref": "#/components/schemas/TenDlcUseCaseEntity" }, "description": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/TenDlcCampaignStatusEntity" }, "failureReason": { "type": "string", "nullable": true }, "submittedAt": { "type": "string", "format": "date-time", "nullable": true }, "activatedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "tcrCampaignId": { "type": "string", "nullable": true }, "tcrStatus": { "$ref": "#/components/schemas/TcrStatusEntity" }, "tcrFailureCode": { "type": "string", "nullable": true }, "tcrFailureReason": { "type": "string", "nullable": true }, "tcrSubmittedAt": { "type": "string", "format": "date-time", "nullable": true }, "tcrLastSyncedAt": { "type": "string", "format": "date-time", "nullable": true }, "vettingScore": { "type": "integer", "format": "int32", "nullable": true }, "throughputLimitPerMinute": { "type": "integer", "format": "int32", "nullable": true }, "isLiveTcrData": { "type": "boolean" }, "subUseCases": { "type": "array", "items": { "type": "string" }, "nullable": true }, "carrierName": { "type": "string", "nullable": true }, "carrierCampaignId": { "type": "string", "nullable": true }, "messageFlow": { "type": "string", "nullable": true }, "sampleMessage1": { "type": "string", "nullable": true }, "sampleMessage2": { "type": "string", "nullable": true }, "sampleMessage3": { "type": "string", "nullable": true }, "sampleMessage4": { "type": "string", "nullable": true }, "sampleMessage5": { "type": "string", "nullable": true }, "embeddedLink": { "type": "boolean" }, "embeddedPhone": { "type": "boolean" }, "ageGated": { "type": "boolean" }, "directLending": { "type": "boolean" }, "affiliateMarketing": { "type": "boolean" }, "subscriberOptin": { "type": "boolean" }, "subscriberOptout": { "type": "boolean" }, "subscriberHelp": { "type": "boolean" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "accountId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "description": "Public TenDlcCampaign payload returned by the API." }, "TenDlcCampaignAssignmentStatusEntity": { "enum": [ "NotAssigned", "Pending", "Assigned", "Failed", "Deleted" ], "type": "string", "x-internal": true }, "TenDlcCampaignStatusEntity": { "enum": [ "Draft", "Submitted", "Active", "Suspended", "Deactivated", "TcrApproved" ], "type": "string", "x-internal": true }, "TenDlcUseCaseEntity": { "enum": [ "Marketing", "Transactional", "OTP", "Mixed", "CustomerCare", "TwoFactorAuthentication", "AccountNotification", "AgentsFranchises", "CarrierExempt", "Charity", "DeliveryNotification", "Emergency", "FraudAlert", "HigherEducation", "K12Education", "LowVolume", "MachineToMachine", "Political", "PollingVoting", "Proxy", "PublicSafetyRestricted", "PublicServiceAnnouncement", "SecurityAlert", "Social", "SoleProprietor", "Sweepstake", "Trial", "UcaasHigh", "UcaasLow" ], "type": "string", "x-internal": true }, "TenDlcVerticalEntity": { "enum": [ "Agriculture", "Communication", "Construction", "Education", "Energy", "Entertainment", "Financial", "Gambling", "Government", "Healthcare", "Hospitality", "HumanResources", "Insurance", "Legal", "Manufacturing", "NonProfit", "ProfessionalServices", "RealEstate", "Retail", "Technology", "Transportation", "Other" ], "type": "string", "x-internal": true }, "UnlinkProviderRequest": { "type": "object", "properties": { "identityId": { "type": "string", "description": "External identity ID to unlink.", "format": "uuid" } }, "additionalProperties": false, "description": "Request to unlink an external provider from account." }, "UpdateAccountAddressRequest": { "type": "object", "properties": { "streetAddress1": { "type": "string", "nullable": true }, "streetAddress2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "stateOrProvince": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateAccountContactRequest": { "type": "object", "properties": { "emailAddress": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateAccountRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "streetAddress1": { "type": "string", "nullable": true }, "streetAddress2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "stateOrProvince": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "emailAddress": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/AccountStatusEntity" } }, "additionalProperties": false }, "UpdateMessageTemplateRequest": { "type": "object", "properties": { "name": { "maxLength": 200, "type": "string", "nullable": true }, "channelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "bodyTemplate": { "maxLength": 2000, "type": "string", "nullable": true }, "defaultVariables": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "updateSubaccountScope": { "type": "boolean" }, "replyOptions": { "type": "array", "items": { "$ref": "#/components/schemas/ReplyOption" }, "nullable": true }, "isActive": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdateQuotaRequest": { "type": "object", "properties": { "dailyLimit": { "type": "integer", "format": "int32", "nullable": true }, "monthlyLimit": { "type": "integer", "format": "int32", "nullable": true }, "ratePerSecond": { "type": "integer", "format": "int32", "nullable": true }, "ratePerMinute": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "UpdateSubaccountRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/SubaccountStatusEntity" } }, "additionalProperties": false }, "UpdateTenDlcBrandIdentityRequest": { "type": "object", "properties": { "legalName": { "type": "string", "nullable": true }, "ein": { "type": "string", "nullable": true }, "brandType": { "$ref": "#/components/schemas/TenDlcBrandTypeEntity" } }, "additionalProperties": false }, "UpdateTenDlcBrandProfileRequest": { "type": "object", "properties": { "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "street": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "vertical": { "$ref": "#/components/schemas/TenDlcVerticalEntity" }, "stockSymbol": { "type": "string", "nullable": true }, "stockExchange": { "type": "string", "nullable": true }, "altBusinessId": { "type": "string", "nullable": true }, "altBusinessIdType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateTenDlcCampaignContentRequest": { "type": "object", "properties": { "useCase": { "$ref": "#/components/schemas/TenDlcUseCaseEntity" }, "subUseCases": { "type": "array", "items": { "type": "string" }, "nullable": true }, "description": { "type": "string", "nullable": true }, "messageFlow": { "type": "string", "nullable": true }, "sampleMessage1": { "type": "string", "nullable": true }, "sampleMessage2": { "type": "string", "nullable": true }, "sampleMessage3": { "type": "string", "nullable": true }, "sampleMessage4": { "type": "string", "nullable": true }, "sampleMessage5": { "type": "string", "nullable": true }, "embeddedLink": { "type": "boolean" }, "embeddedPhone": { "type": "boolean" }, "ageGated": { "type": "boolean" }, "directLending": { "type": "boolean" }, "affiliateMarketing": { "type": "boolean" }, "subscriberOptin": { "type": "boolean" }, "subscriberOptout": { "type": "boolean" }, "subscriberHelp": { "type": "boolean" }, "submitToTcr": { "type": "boolean" } }, "additionalProperties": false }, "UpdateUserProfileRequest": { "required": [ "firstName", "lastName" ], "type": "object", "properties": { "firstName": { "maxLength": 100, "minLength": 1, "type": "string" }, "lastName": { "maxLength": 100, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "UpdateWebhookEndpointRequest": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "nullable": true }, "label": { "maxLength": 200, "type": "string", "nullable": true }, "subscribedEvents": { "$ref": "#/components/schemas/WebhookEventTypeEntity" }, "isActive": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpsertChannelRoutingPolicyRequest": { "type": "object", "properties": { "preferredChannelType": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "fallbackChain": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelTypeEntity" }, "nullable": true }, "isEnabled": { "type": "boolean" }, "receiptTimeoutSeconds": { "type": "integer", "format": "int32", "nullable": true }, "fallbackOnDeliveryFailure": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UserBrandTcrStatus": { "title": "UserBrandTcrStatus", "type": "object", "properties": { "brandId": { "type": "string", "description": "ID of the brand.", "format": "uuid" }, "tcrBrandId": { "type": "string", "description": "TCR Registry brand ID.", "nullable": true }, "tcrStatus": { "type": "string", "description": "Brand status from TCR (Pending, Active, Rejected, etc.).", "nullable": true }, "tcrIdentityStatus": { "type": "string", "description": "Identity verification status.", "nullable": true }, "tcrVettingScore": { "type": "integer", "description": "TCR vetting score (0-100).", "format": "int32", "nullable": true }, "tcrVettingClass": { "type": "string", "description": "TCR vetting class.", "nullable": true }, "tcrFailureCode": { "type": "string", "description": "Failure code if status is Rejected.", "nullable": true }, "tcrFailureReason": { "type": "string", "description": "Failure reason if status is Rejected.", "nullable": true }, "tcrSubmittedAt": { "type": "string", "description": "UTC timestamp when brand was submitted to TCR.", "format": "date-time", "nullable": true }, "tcrLastSyncedAt": { "type": "string", "description": "UTC timestamp of last sync with TCR.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "TCR brand status DTO for user view." }, "UserIdentitiesResponse": { "type": "object", "properties": { "identities": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalIdentityResponse" }, "description": "The set of external identities associated with a user.", "nullable": true } }, "additionalProperties": false, "description": "Response containing list of user's external identities." }, "UserLoginHistory": { "type": "object", "properties": { "userLoginLogId": { "type": "integer", "format": "int32" }, "userId": { "type": "string", "format": "uuid" }, "loggedInAt": { "type": "string", "format": "date-time" }, "wasSuccessful": { "type": "boolean" }, "ipAddress": { "type": "string", "nullable": true }, "userAgent": { "type": "string", "nullable": true }, "failureReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserLoginHistoryPagedResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserLoginHistory" }, "nullable": true }, "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32", "readOnly": true }, "hasNextPage": { "type": "boolean", "readOnly": true }, "hasPreviousPage": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "UserLoginRequest": { "required": [ "email", "password" ], "type": "object", "properties": { "email": { "minLength": 1, "type": "string", "format": "email" }, "password": { "maxLength": 256, "minLength": 6, "type": "string" }, "captchaToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserLoginResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "accessToken": { "type": "string", "nullable": true }, "refreshToken": { "type": "string", "nullable": true }, "userId": { "type": "string", "format": "uuid", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "isEmailConfirmed": { "type": "boolean" }, "pendingEmailAddress": { "type": "string", "nullable": true }, "emailChangeExpiresAt": { "type": "string", "format": "date-time", "nullable": true }, "role": { "type": "string", "nullable": true }, "accountId": { "type": "string", "format": "uuid", "nullable": true }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "errorCode": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "externalEmail": { "type": "string", "nullable": true }, "failedAttemptCount": { "type": "integer", "format": "int32" }, "maxFailedAttempts": { "type": "integer", "format": "int32" }, "remainingAttempts": { "type": "integer", "format": "int32", "readOnly": true }, "isAccountLocked": { "type": "boolean" }, "secondsUntilUnlock": { "type": "number", "format": "double", "nullable": true }, "lockoutTimeMessage": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "UserMfaCodeRequest": { "type": "object", "properties": { "code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserMfaDisableRequest": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "method": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserMfaEnrollmentConfirmRequest": { "type": "object", "properties": { "enrollmentToken": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserMfaEnrollmentSetupRequest": { "type": "object", "properties": { "enrollmentToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserMfaLoginRequest": { "type": "object", "properties": { "mfaToken": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "method": { "type": "string", "nullable": true }, "webAuthnChallengeId": { "type": "string", "format": "uuid", "nullable": true }, "assertion": { "nullable": true }, "rememberMe": { "type": "boolean" } }, "additionalProperties": false }, "UserMfaLoginResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "accessToken": { "type": "string", "nullable": true }, "refreshToken": { "type": "string", "nullable": true }, "userId": { "type": "string", "format": "uuid", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "isEmailConfirmed": { "type": "boolean" }, "pendingEmailAddress": { "type": "string", "nullable": true }, "emailChangeExpiresAt": { "type": "string", "format": "date-time", "nullable": true }, "role": { "type": "string", "nullable": true }, "accountId": { "type": "string", "format": "uuid", "nullable": true }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "errorCode": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "externalEmail": { "type": "string", "nullable": true }, "failedAttemptCount": { "type": "integer", "format": "int32" }, "maxFailedAttempts": { "type": "integer", "format": "int32" }, "remainingAttempts": { "type": "integer", "format": "int32", "readOnly": true }, "isAccountLocked": { "type": "boolean" }, "secondsUntilUnlock": { "type": "number", "format": "double", "nullable": true }, "lockoutTimeMessage": { "type": "string", "nullable": true, "readOnly": true }, "recoveryCodesRemaining": { "type": "integer", "format": "int32", "nullable": true }, "recoveryCodes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UserMfaRecoveryCodesResponse": { "type": "object", "properties": { "recoveryCodes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UserMfaSetupResponse": { "type": "object", "properties": { "otpauthUri": { "type": "string", "nullable": true }, "manualKey": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "UserMfaStatusResponse": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "method": { "type": "string", "nullable": true }, "enrolledAt": { "type": "string", "format": "date-time", "nullable": true }, "recoveryCodesRemaining": { "type": "integer", "format": "int32" }, "hasPasskeys": { "type": "boolean" } }, "additionalProperties": false }, "UserNotificationPreferences": { "title": "UserNotificationPreferences", "type": "object", "properties": { "emailNotifications": { "type": "boolean" }, "failedLoginAlerts": { "type": "boolean" }, "billingThresholdAlerts": { "type": "boolean" }, "webhookFailureAlerts": { "type": "boolean" }, "quotaThresholdAlerts": { "type": "boolean" }, "securityUpdates": { "type": "boolean" } }, "additionalProperties": false, "description": "Public UserNotificationPreferences payload returned by the API." }, "UserRoleEntity": { "enum": [ "Admin", "Manager", "Associate" ], "type": "string", "x-internal": true }, "VerifyRequest": { "type": "object", "properties": { "challengeId": { "type": "string", "format": "uuid" }, "code": { "type": "string", "nullable": true }, "action": { "$ref": "#/components/schemas/StepUpAction" } }, "additionalProperties": false, "description": "Request to verify an email OTP challenge and optionally complete a step-up action." }, "WebAuthnLoginOptionsRequest": { "type": "object", "properties": { "mfaToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WebAuthnOptionsResponse": { "type": "object", "properties": { "challengeId": { "type": "string", "format": "uuid" }, "options": { }, "expiresAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "WebAuthnRegisterCompleteRequest": { "type": "object", "properties": { "challengeId": { "type": "string", "format": "uuid" }, "nickname": { "type": "string", "nullable": true }, "credential": { } }, "additionalProperties": false }, "WebAuthnRenameRequest": { "type": "object", "properties": { "nickname": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WebhookConfig": { "title": "WebhookConfig", "type": "object", "properties": { "webhookUrl": { "type": "string", "description": "The configured endpoint for incoming webhook delivery.", "nullable": true }, "webhookSecret": { "type": "string", "description": "The current secret used to validate webhook payload signatures.", "nullable": true }, "isEnabled": { "type": "boolean", "description": "Indicates whether the webhook delivery is enabled." } }, "additionalProperties": false, "description": "Webhook configuration response" }, "WebhookDeliveryLog": { "title": "WebhookDeliveryLog", "type": "object", "properties": { "webhookDeliveryLogId": { "type": "string", "format": "uuid" }, "webhookEndpointId": { "type": "string", "format": "uuid" }, "eventType": { "$ref": "#/components/schemas/WebhookEventTypeEntity" }, "httpStatusCode": { "type": "integer", "format": "int32", "nullable": true }, "responseTimeMs": { "type": "integer", "format": "int64", "nullable": true }, "attemptNumber": { "type": "integer", "format": "int32" }, "success": { "type": "boolean" }, "errorMessage": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Public WebhookDeliveryLog payload returned by the API." }, "WebhookEndpoint": { "title": "WebhookEndpoint", "type": "object", "properties": { "webhookEndpointId": { "type": "string", "format": "uuid" }, "accountId": { "type": "string", "format": "uuid" }, "subaccountId": { "type": "string", "format": "uuid", "nullable": true }, "url": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "subscribedEvents": { "$ref": "#/components/schemas/WebhookEventTypeEntity" }, "isActive": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "consecutiveFailures": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "secret": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Public WebhookEndpoint payload returned by the API." }, "WebhookEventTypeEntity": { "enum": [ "None", "MessageAccepted", "MessageDelivered", "MessageFailed", "MessageRejected", "MessageDeadLettered", "AccountUpdated", "SubaccountUpdated", "MessageReceived", "MessageExpired", "AllMessageEvents", "RecipientOptedOut", "RecipientOptedIn", "All" ], "type": "string", "x-internal": true }, "WebhookSecret": { "title": "WebhookSecret", "type": "object", "properties": { "webhookSecret": { "type": "string", "description": "Webhook signing secret used to verify incoming payloads.", "nullable": true } }, "additionalProperties": false, "description": "Represents a generated webhook signing secret." } }, "securitySchemes": { "jwt": { "type": "http", "description": "JWT Authorization header using the Bearer scheme.", "scheme": "bearer", "bearerFormat": "JWT" }, "api-key": { "type": "apiKey", "description": "API Key authentication using the X-Api-Key header.", "name": "X-Api-Key", "in": "header" } } }, "tags": [ { "name": "10DLC Registration", "description": "Self-service 10DLC registration and campaign management (JWT-authenticated)." }, { "name": "Account Templates", "description": "Account-scoped template operations accessible via API key or user JWT.\nIntended for programmatic integrations (e.g. the simulator, customer code) and the\nUser Dashboard template preview." }, { "name": "Account Users", "description": "Customer-facing account owner user-management endpoints." }, { "name": "Accounts", "description": "Customer-facing CRUD endpoints for the authenticated user's accounts." }, { "name": "API Keys", "description": "Self-service API key management (JWT-authenticated).\nUsers can create, rotate, revoke, and delete their own API keys." }, { "name": "ArelHub.Api" }, { "name": "Authentication", "description": "Provides endpoints for user authentication including login, logout, and profile management." }, { "name": "Billing", "description": "Self-service billing and subscription management (JWT-authenticated).\nUsers can view their subscription, change plans, and manage billing events." }, { "name": "Carrier Webhooks", "description": "Self-service carrier webhook handling (anonymous).\nUsers can configure carrier webhooks to receive delivery events for their messages." }, { "name": "Channel Consent", "description": "Recipient consent for an account's own (account-level) sending: list who has opted out, look up a\nrecipient's per-channel status, and record opt-out or re-subscribe requests." }, { "name": "Channel Routing", "description": "Self-service channel routing policy management for authenticated account users.\nAllows account admins to configure per-subaccount channel routing preferences and fallback chains." }, { "name": "Email OTP", "description": "Step-up Email OTP endpoints for the currently authenticated user.\nIssue sends a one-time code to the user's email; Verify confirms it. The\ncaller is responsible for binding a successful verification to the actual\nsensitive action it is gating." }, { "name": "Invoices", "description": "Self-service invoice management (JWT-authenticated).\nUsers can view and download their own invoices." }, { "name": "Login History", "description": "Provides endpoints for viewing login history and security statistics.\nAll endpoints require authentication and can only access the authenticated user's own data." }, { "name": "Messages", "description": "Replies received from recipients: every reply an account or subaccount has received, and the\nreplies to one message. Replies are also pushed to webhook endpoints subscribed to\n`MessageReceived`; these endpoints are for catching up and for backfills." }, { "name": "Multi-Factor Authentication", "description": "Self-service management of the signed-in user's authenticator-app second factor.\nEnrolling, regenerating recovery codes and disabling require a step-up grant plus proof of a factor." }, { "name": "Notification Preferences", "description": "" }, { "name": "Number Pools", "description": "Self-service number pool management (JWT-authenticated).\nUsers can create, update, delete, and manage their own number pools." }, { "name": "OAuth2 Authentication", "description": "API endpoints for OAuth2 external authentication.\nSupports provider authorization, callback handling, and identity management." }, { "name": "Onboarding", "description": "Authenticated owner endpoints for private KYC evidence submission and retrieval." }, { "name": "Payment Webhooks", "description": "Self-service payment webhook management (JWT-authenticated).\nUsers can configure webhook URLs, enable/disable webhooks, and regenerate secrets." }, { "name": "Payout Account", "description": "Payout account onboarding, so an Account can charge its Subaccounts." }, { "name": "Phone Numbers", "description": "Self-service phone number management (JWT-authenticated).\nUsers can search, purchase, assign, and release phone numbers." }, { "name": "Plans", "description": "Self-service subscription plan management (anonymous).\nUsers can view available subscription plans without authentication." }, { "name": "Privacy", "description": "Self-service privacy and data subject request management (JWT-authenticated).\nUsers can request data exports, account erasure, and manage consent preferences." }, { "name": "Provider Discovery", "description": "Anonymous sign-in provider discovery. Resolves which external sign-in provider (SSO)\nhandles an email domain so a login page can route the user before authentication.\nDiscovery rules and provider health are staff-only and live under\n`api/internal/staff/provider-discovery`." }, { "name": "PublicOpenApi", "description": "Serves the curated public OpenAPI contract without exposing Swagger UI or private documents." }, { "name": "Quota", "description": "Self-service quota management (JWT-authenticated).\nUsers can view and manage their own account and subaccount quota usage." }, { "name": "Realtime Metrics", "description": "Self-service real-time metrics retrieval (JWT-authenticated).\nUsers can view current and historical metrics for their accounts and subaccounts." }, { "name": "Registration", "description": "Self-service account registration and onboarding." }, { "name": "Risk Signals", "description": "Self-service risk signal retrieval (JWT-authenticated).\nUsers can view detailed and aggregated risk signals for their messages." }, { "name": "Subaccount Charges", "description": "Self-service subaccount charge management (JWT-authenticated).\nUsers can create manual charges and view payment history for their subaccounts." }, { "name": "Subaccount Payment Methods", "description": "Payment method management for a subaccount, scoped to the parent account's payout account." }, { "name": "Subaccounts", "description": "Customer-facing endpoints for managing subaccounts within an account." }, { "name": "Support Cases", "description": "Self-service support case management (JWT-authenticated).\nUsers can create, view, and manage support cases for their accounts." }, { "name": "TCR Webhooks", "description": "Initialises the controller with TCR webhook service, options, and logger." }, { "name": "Templates", "description": "Self-service message template management (JWT-authenticated).\nUsers can create, update, delete, and render message templates for their accounts and subaccounts" }, { "name": "Token Management", "description": "Self-service token management (JWT-authenticated).\nUsers can refresh access tokens, revoke refresh tokens, and manage active sessions for their accounts." }, { "name": "Webhooks", "description": "User self-service webhook management (JWT-authenticated).\nUsers can create, update, delete, test, and view delivery logs for their own webhooks." }, { "name": "WhatsApp Webhooks", "description": "Receives and processes webhook events from Meta's WhatsApp Business Platform.\nHandles message delivery status callbacks and subscription verification.\n \nWebhook flow:\n1. GET /v1/webhooks/whatsapp (Meta verification handshake)\n2. POST /v1/webhooks/whatsapp (delivery receipt events)" } ] }