{ "openapi": "3.1.0", "info": { "title": "SMOKESTACK Customer Connections API", "version": "2026-08-24", "description": "Revision-filtered public contract. Documentation is not runtime activation or partner authorization." }, "servers": [ { "url": "https://partner-api.invalid", "description": "Deliberately non-routable placeholder for generated clients and interactive documentation. Configure only the exact base URL supplied during credential-bound partner onboarding. Publishing a contract does not select a production or sandbox endpoint and does not assert that the revision is deployed, enabled for a partner, or production-ready." } ], "paths": { "/partner/customer-connections/v1/capabilities": { "get": { "operationId": "getPartnerCustomerConnectionCapabilities", "summary": "Read Customer Connections contract capabilities", "description": "Returns contract maturity and the non-enumerating authorization model. It returns no tenant or customer data and does not claim runtime readiness.", "tags": [ "Customer Connections v1" ], "security": [ { "partnerServiceBearer": [] } ], "parameters": [ { "schema": { "type": "string", "const": "2026-08-24" }, "required": true, "name": "smokestack-api-version", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "x-request-id", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "x-correlation-id", "in": "header" } ], "responses": { "200": { "description": "Successful response within the operation's declared authority and data class.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerCapabilitiesResponse" } } } }, "400": { "description": "Invalid request syntax. Private customer-matching outcomes never use this response for connection-intent creation.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "401": { "description": "The required partner or subject credential is missing or invalid.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "403": { "description": "The partner credential lacks authority for this operation; no customer or match state is disclosed.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "406": { "description": "The requested contract revision is unsupported.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "429": { "description": "Partner, external-subject, intent, or pairwise-subject rate limit exceeded.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "500": { "description": "Unexpected error without customer or match details.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "503": { "description": "An authoritative dependency is unavailable; the service does not guess.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } } }, "x-smokestack-operation-status": "planned", "x-smokestack-authority": "partner", "x-smokestack-data-class": "public", "x-smokestack-required-subject-scopes": [], "x-smokestack-optional-subject-scopes": [], "x-smokestack-supported-api-versions": [ "2026-08-24" ], "x-smokestack-required-operation": "getPartnerCustomerConnectionCapabilities", "x-smokestack-idempotency": { "required": false } } }, "/partner/customer-connections/v1/connection-intents": { "post": { "operationId": "createPartnerCustomerConnectionIntent", "summary": "Create a customer-controlled connection intent", "description": "Accepts verified correlation claims for an external account and always returns the same 202 shape for zero, one, or multiple private candidates. Matching never authorizes access; no candidate, masked contact, customer identifier, existence signal, or out-of-band candidate notification is returned or triggered.", "tags": [ "Customer Connections v1" ], "security": [ { "partnerServiceBearer": [] } ], "parameters": [ { "schema": { "type": "string", "const": "2026-08-24" }, "required": true, "name": "smokestack-api-version", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "x-request-id", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "x-correlation-id", "in": "header" }, { "schema": { "type": "string", "minLength": 16, "maxLength": 200 }, "required": true, "name": "idempotency-key", "in": "header" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerConnectionIntentRequest" } } } }, "responses": { "202": { "description": "Accepted without disclosing customer-match state.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerConnectionIntentResponse" } } } }, "400": { "description": "Invalid request syntax. Private customer-matching outcomes never use this response for connection-intent creation.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "401": { "description": "The required partner or subject credential is missing or invalid.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "403": { "description": "The partner credential lacks authority for this operation; no customer or match state is disclosed.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "406": { "description": "The requested contract revision is unsupported.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "409": { "description": "The idempotency key was reused with a different canonical payload.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "429": { "description": "Partner, external-subject, intent, or pairwise-subject rate limit exceeded.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "500": { "description": "Unexpected error without customer or match details.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "503": { "description": "An authoritative dependency is unavailable; the service does not guess.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } } }, "x-smokestack-operation-status": "planned", "x-smokestack-authority": "partner", "x-smokestack-data-class": "customer_personal", "x-smokestack-required-subject-scopes": [], "x-smokestack-optional-subject-scopes": [], "x-smokestack-supported-api-versions": [ "2026-08-24" ], "x-smokestack-required-operation": "createPartnerCustomerConnectionIntent", "x-smokestack-idempotency": { "required": true, "retentionSeconds": 604800, "replay": "same scoped key and canonical payload returns the stored business status and payload", "conflict": "same scoped key with a different canonical payload returns idempotency_conflict" } } }, "/partner/customer-connections/v1/subject-tokens": { "post": { "operationId": "exchangePartnerCustomerSubjectToken", "summary": "Exchange an authorization code or rotate a refresh token", "description": "Exchanges a single-use code created only after SMOKESTACK customer authentication and consent, or rotates a grant-bound refresh token. Every invalid, expired, replayed, denied, absent-match, and ambiguous-match outcome is externally collapsed to invalid_grant.", "tags": [ "Customer Connections v1" ], "security": [ { "partnerServiceBearer": [] } ], "parameters": [ { "schema": { "type": "string", "const": "2026-08-24" }, "required": true, "name": "smokestack-api-version", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "x-request-id", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "x-correlation-id", "in": "header" }, { "schema": { "type": "string", "minLength": 16, "maxLength": 200 }, "required": true, "name": "idempotency-key", "in": "header" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerSubjectTokenRequest" } } } }, "responses": { "200": { "description": "Successful response within the operation's declared authority and data class.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerSubjectTokenResponse" } } } }, "400": { "description": "Malformed input or generic invalid_grant. The response never distinguishes denial, absence, ambiguity, expiration, or replay.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "401": { "description": "The required partner or subject credential is missing or invalid.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "403": { "description": "The partner credential lacks authority for this operation; no customer or match state is disclosed.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "406": { "description": "The requested contract revision is unsupported.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "409": { "description": "The idempotency key was reused with a different canonical payload.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "429": { "description": "Partner, external-subject, intent, or pairwise-subject rate limit exceeded.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "500": { "description": "Unexpected error without customer or match details.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "503": { "description": "An authoritative dependency is unavailable; the service does not guess.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } } }, "x-smokestack-operation-status": "planned", "x-smokestack-authority": "partner", "x-smokestack-data-class": "customer_personal", "x-smokestack-required-subject-scopes": [], "x-smokestack-optional-subject-scopes": [], "x-smokestack-supported-api-versions": [ "2026-08-24" ], "x-smokestack-required-operation": "exchangePartnerCustomerSubjectToken", "x-smokestack-idempotency": { "required": true, "retentionSeconds": 604800, "replay": "same scoped key and canonical payload returns the stored business status and payload", "conflict": "same scoped key with a different canonical payload returns idempotency_conflict" } } }, "/partner/customer-connections/v1/me": { "get": { "operationId": "getPartnerConnectedCustomerProfile", "summary": "Read the connected customer's granted profile", "description": "Returns only the authenticated pairwise subject. Basic profile is required; contact and birth date are omitted unless their separately approved scopes are present.", "tags": [ "Customer Connections v1" ], "security": [ { "customerSubjectBearer": [] } ], "parameters": [ { "schema": { "type": "string", "const": "2026-08-24" }, "required": true, "name": "smokestack-api-version", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "x-request-id", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "x-correlation-id", "in": "header" } ], "responses": { "200": { "description": "Successful response within the operation's declared authority and data class.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerProfileResponse" } } } }, "400": { "description": "Invalid request syntax. Private customer-matching outcomes never use this response for connection-intent creation.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "401": { "description": "The required partner or subject credential is missing or invalid.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "403": { "description": "The subject credential, approved scopes, or active grant does not permit this operation.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "406": { "description": "The requested contract revision is unsupported.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "429": { "description": "Partner, external-subject, intent, or pairwise-subject rate limit exceeded.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "500": { "description": "Unexpected error without customer or match details.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "503": { "description": "An authoritative dependency is unavailable; the service does not guess.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } } }, "x-smokestack-operation-status": "planned", "x-smokestack-authority": "customer-subject", "x-smokestack-data-class": "customer_personal", "x-smokestack-required-subject-scopes": [ "customer.profile.basic" ], "x-smokestack-optional-subject-scopes": [ "customer.profile.contact", "customer.profile.birth_date" ], "x-smokestack-supported-api-versions": [ "2026-08-24" ], "x-smokestack-required-operation": "getPartnerConnectedCustomerProfile", "x-smokestack-idempotency": { "required": false } } }, "/partner/customer-connections/v1/me/medical-eligibility": { "get": { "operationId": "getPartnerConnectedCustomerMedicalEligibility", "summary": "Read separately consented medical eligibility", "description": "Returns only normalized eligibility status and freshness for the authenticated subject. It exposes no medical identifier, condition, provider payload, purchase allowance, allotment, remaining quantity, or quantity basis.", "tags": [ "Customer Connections v1" ], "security": [ { "customerSubjectBearer": [] } ], "parameters": [ { "schema": { "type": "string", "const": "2026-08-24" }, "required": true, "name": "smokestack-api-version", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "x-request-id", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "x-correlation-id", "in": "header" } ], "responses": { "200": { "description": "Successful response within the operation's declared authority and data class.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerMedicalEligibilityResponse" } } } }, "400": { "description": "Invalid request syntax. Private customer-matching outcomes never use this response for connection-intent creation.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "401": { "description": "The required partner or subject credential is missing or invalid.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "403": { "description": "The subject credential, approved scopes, or active grant does not permit this operation.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "406": { "description": "The requested contract revision is unsupported.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "429": { "description": "Partner, external-subject, intent, or pairwise-subject rate limit exceeded.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "500": { "description": "Unexpected error without customer or match details.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "503": { "description": "An authoritative dependency is unavailable; the service does not guess.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } } }, "x-smokestack-operation-status": "planned", "x-smokestack-authority": "customer-subject", "x-smokestack-data-class": "customer_sensitive", "x-smokestack-required-subject-scopes": [ "customer.medical_eligibility.read" ], "x-smokestack-optional-subject-scopes": [], "x-smokestack-supported-api-versions": [ "2026-08-24" ], "x-smokestack-required-operation": "getPartnerConnectedCustomerMedicalEligibility", "x-smokestack-idempotency": { "required": false } } }, "/partner/customer-connections/v1/me/connection": { "delete": { "operationId": "revokePartnerCustomerConnection", "summary": "Revoke the current customer connection", "description": "Revokes the grant that minted the authenticated subject credential. Refresh stops immediately and access tokens fail the grant-version check; the operation never accepts another customer's identifier.", "tags": [ "Customer Connections v1" ], "security": [ { "customerSubjectBearer": [] } ], "parameters": [ { "schema": { "type": "string", "const": "2026-08-24" }, "required": true, "name": "smokestack-api-version", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "x-request-id", "in": "header" }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "required": false, "name": "x-correlation-id", "in": "header" } ], "responses": { "200": { "description": "Successful response within the operation's declared authority and data class.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerRevokeResponse" } } } }, "400": { "description": "Invalid request syntax. Private customer-matching outcomes never use this response for connection-intent creation.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "401": { "description": "The required partner or subject credential is missing or invalid.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "403": { "description": "The subject credential, approved scopes, or active grant does not permit this operation.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "406": { "description": "The requested contract revision is unsupported.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "429": { "description": "Partner, external-subject, intent, or pairwise-subject rate limit exceeded.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "500": { "description": "Unexpected error without customer or match details.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } }, "503": { "description": "An authoritative dependency is unavailable; the service does not guess.", "headers": { "SMOKESTACK-API-Version": { "description": "The negotiated compatible contract revision.", "schema": { "type": "string", "const": "2026-08-24" } }, "X-Request-ID": { "description": "The request identifier accepted from the caller or generated by SMOKESTACK.", "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "The end-to-end correlation identifier.", "schema": { "type": "string" } }, "Deprecation": { "description": "RFC 9745 Structured Field Date when an operation or revision is deprecated.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerCustomerError" } } } } }, "x-smokestack-operation-status": "planned", "x-smokestack-authority": "customer-subject", "x-smokestack-data-class": "customer_personal", "x-smokestack-required-subject-scopes": [], "x-smokestack-optional-subject-scopes": [], "x-smokestack-supported-api-versions": [ "2026-08-24" ], "x-smokestack-required-operation": "revokePartnerCustomerConnection", "x-smokestack-idempotency": { "required": false, "intrinsic": true } } } }, "components": { "schemas": { "PartnerCustomerCapabilitiesResponse": { "type": "object", "properties": { "apiVersion": { "type": "string", "enum": [ "2026-08-24" ] }, "connectionFlow": { "type": "object", "properties": { "matching": { "type": "string", "enum": [ "PRIVATE_NON_ENUMERATING" ] }, "customerAuthorization": { "type": "string", "enum": [ "SMOKESTACK_CONTROLLED" ] }, "pairwiseSubjects": { "type": "boolean", "enum": [ true ] }, "candidateSignalsReturned": { "type": "boolean", "enum": [ false ] }, "intentStatusEndpoint": { "type": "boolean", "enum": [ false ] } }, "required": [ "matching", "customerAuthorization", "pairwiseSubjects", "candidateSignalsReturned", "intentStatusEndpoint" ], "additionalProperties": false }, "operations": { "type": "array", "items": { "type": "object", "properties": { "operationId": { "type": "string", "minLength": 1, "maxLength": 200 }, "status": { "type": "string", "enum": [ "planned" ] }, "authority": { "type": "string", "enum": [ "partner", "customer-subject" ] }, "dataClass": { "type": "string", "enum": [ "public", "customer_personal", "customer_sensitive" ] }, "requiredSubjectScopes": { "type": "array", "items": { "type": "string", "enum": [ "customer.profile.basic", "customer.profile.contact", "customer.profile.birth_date", "customer.medical_eligibility.read" ] } } }, "required": [ "operationId", "status", "authority", "dataClass", "requiredSubjectScopes" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "apiVersion": { "type": "string", "enum": [ "2026-08-24" ] }, "requestId": { "type": "string", "minLength": 1, "maxLength": 200 }, "generatedAt": { "type": "string", "format": "date-time" } }, "required": [ "apiVersion", "requestId", "generatedAt" ], "additionalProperties": false } }, "required": [ "apiVersion", "connectionFlow", "operations", "meta" ], "additionalProperties": false }, "PartnerCustomerError": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "invalid_request", "authentication_required", "permission_denied", "api_version_not_supported", "invalid_grant", "idempotency_conflict", "rate_limited", "dependency_unavailable", "internal_error" ] }, "message": { "type": "string", "minLength": 1, "maxLength": 500, "description": "Public, non-diagnostic message. invalid_grant must never describe customer or match state." }, "requestId": { "type": "string", "minLength": 1, "maxLength": 200 }, "retryable": { "type": "boolean" } }, "required": [ "code", "message", "requestId", "retryable" ], "additionalProperties": false }, "PartnerCustomerConnectionIntentRequest": { "type": "object", "properties": { "externalSubject": { "type": "string", "pattern": "^ext_[A-Za-z0-9_-]{16,120}$" }, "purpose": { "type": "string", "enum": [ "CUSTOMER_ACCOUNT_CONNECTION" ] }, "requestedScopes": { "type": "array", "items": { "type": "string", "enum": [ "customer.profile.basic", "customer.profile.contact", "customer.profile.birth_date", "customer.medical_eligibility.read" ] }, "minItems": 1, "maxItems": 4 }, "redirectUri": { "type": "string", "maxLength": 2048, "format": "uri" }, "state": { "type": "string", "pattern": "^[A-Za-z0-9._~-]{16,512}$" }, "codeChallenge": { "type": "string", "pattern": "^[A-Za-z0-9_-]{43,128}$" }, "codeChallengeMethod": { "type": "string", "enum": [ "S256" ] }, "correlationClaims": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "EMAIL" ] }, "value": { "type": "string", "maxLength": 320, "format": "email" }, "verifiedAt": { "type": "string", "format": "date-time" }, "verificationMethod": { "type": "string", "enum": [ "EMAIL_OTP", "IN_PERSON", "ACCOUNT_RECORD" ] } }, "required": [ "kind", "value", "verifiedAt", "verificationMethod" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "PHONE" ] }, "value": { "type": "string", "pattern": "^\\+[1-9]\\d{7,14}$" }, "verifiedAt": { "type": "string", "format": "date-time" }, "verificationMethod": { "type": "string", "enum": [ "SMS_OTP", "IN_PERSON", "ACCOUNT_RECORD" ] } }, "required": [ "kind", "value", "verifiedAt", "verificationMethod" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "LEGAL_NAME" ] }, "givenName": { "type": "string", "minLength": 1, "maxLength": 100 }, "familyName": { "type": "string", "minLength": 1, "maxLength": 100 }, "verifiedAt": { "type": "string", "format": "date-time" }, "verificationMethod": { "type": "string", "enum": [ "GOVERNMENT_ID", "IN_PERSON", "ACCOUNT_RECORD" ] } }, "required": [ "kind", "givenName", "familyName", "verifiedAt", "verificationMethod" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "DATE_OF_BIRTH" ] }, "value": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "verifiedAt": { "type": "string", "format": "date-time" }, "verificationMethod": { "type": "string", "enum": [ "GOVERNMENT_ID", "IN_PERSON", "ACCOUNT_RECORD" ] } }, "required": [ "kind", "value", "verifiedAt", "verificationMethod" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "POSTAL_ADDRESS" ] }, "postalCode": { "type": "string", "minLength": 3, "maxLength": 20 }, "countryCode": { "type": "string", "pattern": "^[A-Z]{2}$" }, "verifiedAt": { "type": "string", "format": "date-time" }, "verificationMethod": { "type": "string", "enum": [ "GOVERNMENT_ID", "IN_PERSON", "ACCOUNT_RECORD" ] } }, "required": [ "kind", "postalCode", "countryCode", "verifiedAt", "verificationMethod" ], "additionalProperties": false } ] }, "minItems": 3, "maxItems": 5 } }, "required": [ "externalSubject", "purpose", "requestedScopes", "redirectUri", "state", "codeChallenge", "codeChallengeMethod", "correlationClaims" ], "additionalProperties": false }, "PartnerCustomerConnectionIntentResponse": { "type": "object", "properties": { "connectionIntentId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "AWAITING_CUSTOMER_AUTHORIZATION" ] }, "authorizationUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "expiresAt": { "type": "string", "format": "date-time" }, "meta": { "type": "object", "properties": { "apiVersion": { "type": "string", "enum": [ "2026-08-24" ] }, "requestId": { "type": "string", "minLength": 1, "maxLength": 200 }, "generatedAt": { "type": "string", "format": "date-time" } }, "required": [ "apiVersion", "requestId", "generatedAt" ], "additionalProperties": false } }, "required": [ "connectionIntentId", "status", "authorizationUrl", "expiresAt", "meta" ], "additionalProperties": false }, "PartnerCustomerSubjectTokenRequest": { "oneOf": [ { "type": "object", "properties": { "grantType": { "type": "string", "enum": [ "authorization_code" ] }, "authorizationCode": { "type": "string", "pattern": "^ccac_[A-Za-z0-9_-]{32,200}$" }, "codeVerifier": { "type": "string", "pattern": "^[A-Za-z0-9._~-]{43,128}$" }, "redirectUri": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "grantType", "authorizationCode", "codeVerifier", "redirectUri" ], "additionalProperties": false }, { "type": "object", "properties": { "grantType": { "type": "string", "enum": [ "refresh_token" ] }, "refreshToken": { "type": "string", "pattern": "^ccrt_[A-Za-z0-9_-]{32,300}$" } }, "required": [ "grantType", "refreshToken" ], "additionalProperties": false } ] }, "PartnerCustomerSubjectTokenResponse": { "type": "object", "properties": { "tokenType": { "type": "string", "enum": [ "Bearer" ] }, "accessToken": { "type": "string", "minLength": 32, "maxLength": 4096 }, "expiresIn": { "type": "integer", "exclusiveMinimum": 0, "maximum": 900 }, "refreshToken": { "type": "string", "pattern": "^ccrt_[A-Za-z0-9_-]{32,300}$" }, "refreshExpiresAt": { "type": "string", "format": "date-time" }, "scope": { "type": "array", "items": { "type": "string", "enum": [ "customer.profile.basic", "customer.profile.contact", "customer.profile.birth_date", "customer.medical_eligibility.read" ] }, "minItems": 1 }, "subject": { "type": "string", "pattern": "^cusub_v1_[A-Za-z0-9_-]{32,64}$" }, "grantId": { "type": "string", "format": "uuid" }, "meta": { "type": "object", "properties": { "apiVersion": { "type": "string", "enum": [ "2026-08-24" ] }, "requestId": { "type": "string", "minLength": 1, "maxLength": 200 }, "generatedAt": { "type": "string", "format": "date-time" } }, "required": [ "apiVersion", "requestId", "generatedAt" ], "additionalProperties": false } }, "required": [ "tokenType", "accessToken", "expiresIn", "refreshToken", "refreshExpiresAt", "scope", "subject", "grantId", "meta" ], "additionalProperties": false }, "PartnerCustomerProfileResponse": { "type": "object", "properties": { "subject": { "type": "string", "pattern": "^cusub_v1_[A-Za-z0-9_-]{32,64}$" }, "grantedScopes": { "type": "array", "items": { "type": "string", "enum": [ "customer.profile.basic", "customer.profile.contact", "customer.profile.birth_date", "customer.medical_eligibility.read" ] }, "minItems": 1 }, "profile": { "type": "object", "properties": { "displayName": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 200 }, "legalName": { "type": "object", "properties": { "givenName": { "type": "string", "minLength": 1, "maxLength": 100 }, "familyName": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "givenName", "familyName" ], "additionalProperties": false }, "contact": { "type": "object", "properties": { "email": { "type": [ "string", "null" ], "maxLength": 320, "format": "email" }, "phone": { "type": [ "string", "null" ], "pattern": "^\\+[1-9]\\d{7,14}$" } }, "required": [ "email", "phone" ], "additionalProperties": false }, "birthDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "displayName" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "apiVersion": { "type": "string", "enum": [ "2026-08-24" ] }, "requestId": { "type": "string", "minLength": 1, "maxLength": 200 }, "generatedAt": { "type": "string", "format": "date-time" } }, "required": [ "apiVersion", "requestId", "generatedAt" ], "additionalProperties": false } }, "required": [ "subject", "grantedScopes", "profile", "meta" ], "additionalProperties": false }, "PartnerCustomerMedicalEligibilityResponse": { "type": "object", "properties": { "subject": { "type": "string", "pattern": "^cusub_v1_[A-Za-z0-9_-]{32,64}$" }, "eligibility": { "type": "object", "properties": { "program": { "type": "string", "enum": [ "MEDICAL_CANNABIS" ] }, "jurisdiction": { "type": "string", "pattern": "^US-[A-Z0-9]{2,3}$" }, "status": { "type": "string", "enum": [ "ELIGIBLE", "INELIGIBLE", "EXPIRED", "UNAVAILABLE", "NOT_CHECKED" ] }, "checkedAt": { "type": [ "string", "null" ], "format": "date-time" }, "validUntil": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "program", "jurisdiction", "status", "checkedAt", "validUntil" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "apiVersion": { "type": "string", "enum": [ "2026-08-24" ] }, "requestId": { "type": "string", "minLength": 1, "maxLength": 200 }, "generatedAt": { "type": "string", "format": "date-time" } }, "required": [ "apiVersion", "requestId", "generatedAt" ], "additionalProperties": false } }, "required": [ "subject", "eligibility", "meta" ], "additionalProperties": false }, "PartnerCustomerRevokeResponse": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "REVOKED" ] }, "revokedAt": { "type": "string", "format": "date-time" }, "meta": { "type": "object", "properties": { "apiVersion": { "type": "string", "enum": [ "2026-08-24" ] }, "requestId": { "type": "string", "minLength": 1, "maxLength": 200 }, "generatedAt": { "type": "string", "format": "date-time" } }, "required": [ "apiVersion", "requestId", "generatedAt" ], "additionalProperties": false } }, "required": [ "status", "revokedAt", "meta" ], "additionalProperties": false } }, "securitySchemes": { "partnerServiceBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Short-lived, server-only partner credential used for capabilities, intent creation, and token exchange. Purpose \"partner-customer-connections\", audience \"partner-customer-connections-service\", and operation scope \"customer-connections:partner:\" are exact validation inputs. Claims: assignmentId, aud, exp, iat, iss, jti, operation, partnerId, purpose, sub, tenantId, tokenUse. It reaches no customer data on its own." }, "customerSubjectBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Short-lived access token minted only from a customer-approved grant through the partner-authenticated token exchange. Purpose \"customer-connection-subject\", audience \"partner-customer-connections-service\", and maximum lifetime 900 seconds. Claims: assignmentId, aud, azp, exp, grantId, grantVersion, iat, iss, jti, purpose, scope, sub, tenantId, tokenUse. The sub claim is pairwise for tenant, partner assignment, and canonical customer; azp and assignmentId bind it to the external client. It is the sole Authorization bearer on /me calls, avoiding an impossible two-Authorization-header design. Browser code must never receive it. Every request checks the active grant and grantVersion so revocation fails closed." } } } }