{ "openapi": "3.1.0", "info": { "title": "Agent Authority API", "description": "Register AI agents to identity-verified owners and check who owns an agent, with registry-signed records.", "version": "0.1.0" }, "paths": { "/api/account/email": { "get": { "summary": "Email Configuration", "operationId": "email_configuration_api_account_email_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "post": { "summary": "Email Request", "operationId": "email_request_api_account_email_post", "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailEnrollment" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/account/email/{enrollment_id}/confirm": { "post": { "summary": "Email Confirm", "operationId": "email_confirm_api_account_email__enrollment_id__confirm_post", "parameters": [ { "name": "enrollment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Enrollment Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailConfirmation" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/account/email/{enrollment_id}/revoke": { "post": { "summary": "Email Revoke", "operationId": "email_revoke_api_account_email__enrollment_id__revoke_post", "parameters": [ { "name": "enrollment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Enrollment Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/provider/configuration": { "get": { "summary": "Provider Configuration", "operationId": "provider_configuration_api_provider_configuration_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/account/biometric-consent": { "post": { "summary": "Biometric Consent", "operationId": "biometric_consent_api_account_biometric_consent_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BiometricConsent" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/owners/{owner_id}/provider-case": { "post": { "summary": "Prepare Case", "operationId": "prepare_case_api_owners__owner_id__provider_case_post", "parameters": [ { "name": "owner_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Owner Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/CaseStart" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/provider/cases/{case_id}": { "get": { "summary": "Provider Case", "operationId": "provider_case_api_provider_cases__case_id__get", "parameters": [ { "name": "case_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Case Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/provider/cases/{case_id}/sdk-token": { "post": { "summary": "Provider Token", "operationId": "provider_token_api_provider_cases__case_id__sdk_token_post", "parameters": [ { "name": "case_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Case Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/provider/cases/{case_id}/reconcile": { "post": { "summary": "Reconcile Case", "operationId": "reconcile_case_api_provider_cases__case_id__reconcile_post", "parameters": [ { "name": "case_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Case Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/operations/{operation_id}": { "get": { "summary": "Operation Receipt", "operationId": "operation_receipt_api_operations__operation_id__get", "parameters": [ { "name": "operation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Operation Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/health": { "get": { "summary": "Health", "operationId": "health_api_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/auth/options": { "post": { "summary": "Options", "operationId": "options_api_auth_options_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ceremony" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/auth/finish": { "post": { "summary": "Finish", "operationId": "finish_api_auth_finish_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Finish" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/auth/logout": { "post": { "summary": "Logout", "operationId": "logout_api_auth_logout_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/auth/recovery": { "post": { "summary": "Begin Recovery", "operationId": "begin_recovery_api_auth_recovery_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecoveryStart" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/auth/recovery/duplicate": { "post": { "summary": "Duplicate Recovery", "operationId": "duplicate_recovery_api_auth_recovery_duplicate_post", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/auth/recovery/{recovery_id}": { "get": { "summary": "Recovery Status", "operationId": "recovery_status_api_auth_recovery__recovery_id__get", "parameters": [ { "name": "recovery_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Recovery Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/auth/recovery/options": { "post": { "summary": "Recovery Options", "operationId": "recovery_options_api_auth_recovery_options_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecoveryOptions" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/me": { "get": { "summary": "Me", "operationId": "me_api_me_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/entities": { "post": { "summary": "Entity", "operationId": "entity_api_entities_post", "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityEnrollment" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/entities/{entity_id}/representative-requests": { "post": { "summary": "Representative Request", "operationId": "representative_request_api_entities__entity_id__representative_requests_post", "parameters": [ { "name": "entity_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Entity Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepresentativeRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/owners/{owner_id}/change-requests": { "post": { "summary": "Owner Change", "operationId": "owner_change_api_owners__owner_id__change_requests_post", "parameters": [ { "name": "owner_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Owner Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OwnerChange" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/identity/requests/{workflow_id}/complete": { "post": { "summary": "Complete Identity", "operationId": "complete_identity_api_identity_requests__workflow_id__complete_post", "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/agreements": { "get": { "summary": "Agreements", "operationId": "agreements_api_agreements_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/public/trust-key": { "get": { "summary": "Trust Key", "operationId": "trust_key_api_public_trust_key_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/public/agents/{agent_id}": { "get": { "summary": "Status", "operationId": "status_api_public_agents__agent_id__get", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "nonce", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{32}$" }, { "type": "null" } ], "title": "Nonce" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/public/names/{owner}/{agent_name}": { "get": { "summary": "Status By Name", "description": "The signed status of @username/agentname or @domain/agentname; the @ is optional.\n\nThe address is a pointer: the status is keyed by agent ID. A company's other proven domains and old\naddresses in their 90-day hold answer 308 to the current address. 404 unless the address is public.", "operationId": "status_by_name_api_public_names__owner___agent_name__get", "parameters": [ { "name": "owner", "in": "path", "required": true, "schema": { "type": "string", "title": "Owner" } }, { "name": "agent_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Name" } }, { "name": "nonce", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{32}$" }, { "type": "null" } ], "title": "Nonce" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/public/audit": { "get": { "summary": "Audit Proof", "operationId": "audit_proof_api_public_audit_get", "parameters": [ { "name": "after", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "title": "After" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 1000, "title": "Limit" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/public/checkpoint": { "get": { "summary": "Checkpoint", "operationId": "checkpoint_api_public_checkpoint_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/proposals/{proposal_id}/handoff": { "get": { "summary": "Signing Handoff", "operationId": "signing_handoff_api_proposals__proposal_id__handoff_get", "parameters": [ { "name": "proposal_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Proposal Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/agents/prepare": { "post": { "summary": "Prepare", "operationId": "prepare_api_agents_prepare_post", "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Prepare" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/agents/{agent_id}/name": { "post": { "summary": "Rename", "description": "Rename an agent. Its ID, history and signatures stay; the old address redirects for 90 days.", "operationId": "rename_api_agents__agent_id__name_post", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rename" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/agents/{agent_id}/changes": { "post": { "summary": "Change", "operationId": "change_api_agents__agent_id__changes_post", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Change" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/acceptances": { "post": { "summary": "Accept", "operationId": "accept_api_acceptances_post", "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Batch" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/agents/{agent_id}/revoke": { "post": { "summary": "Revoke", "operationId": "revoke_api_agents__agent_id__revoke_post", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Revoke" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/disclosures/requests": { "get": { "summary": "Disclosure Requests", "operationId": "disclosure_requests_api_disclosures_requests_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } }, "post": { "summary": "Disclosure Request", "operationId": "disclosure_request_api_disclosures_requests_post", "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisclosureRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/disclosures/{disclosure_id}/approve": { "post": { "summary": "Approve", "operationId": "approve_api_disclosures__disclosure_id__approve_post", "parameters": [ { "name": "disclosure_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Disclosure Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/registry__app__Approval" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/disclosures/{disclosure_id}/redeem": { "post": { "summary": "Redeem", "operationId": "redeem_api_disclosures__disclosure_id__redeem_post", "parameters": [ { "name": "disclosure_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Disclosure Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Redemption" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/disclosures/{disclosure_id}/revoke": { "post": { "summary": "Revoke Disclosure", "operationId": "revoke_disclosure_api_disclosures__disclosure_id__revoke_post", "parameters": [ { "name": "disclosure_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Disclosure Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/disputes": { "post": { "summary": "File Dispute", "operationId": "file_dispute_api_disputes_post", "parameters": [ { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisputeFile" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "summary": "Disputes", "operationId": "disputes_api_disputes_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/disputes/{dispute_id}": { "get": { "summary": "Dispute Detail", "operationId": "dispute_detail_api_disputes__dispute_id__get", "parameters": [ { "name": "dispute_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Dispute Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/disputes/{dispute_id}/respond": { "post": { "summary": "Respond Dispute", "operationId": "respond_dispute_api_disputes__dispute_id__respond_post", "parameters": [ { "name": "dispute_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Dispute Id" } }, { "name": "idempotency-key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128, "title": "Idempotency-Key" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisputeAction" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/billing/{owner_id}": { "get": { "summary": "Billing", "operationId": "billing_api_billing__owner_id__get", "parameters": [ { "name": "owner_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Owner Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/auth/account/email": { "post": { "summary": "Confirm Email", "operationId": "confirm_email_api_auth_account_email_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/auth/account/qr/{identifier}": { "get": { "summary": "Qr", "operationId": "qr_api_auth_account_qr__identifier__get", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Identifier" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/auth/account/finish": { "post": { "summary": "Finish", "operationId": "finish_api_auth_account_finish_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/auth/account/login/password": { "post": { "summary": "Login Password", "operationId": "login_password_api_auth_account_login_password_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginPassword" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/auth/account/login/authenticator": { "post": { "summary": "Login Authenticator", "operationId": "login_authenticator_api_auth_account_login_authenticator_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Login" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/auth/account/login/recovery-code": { "post": { "summary": "Login Recovery Code", "operationId": "login_recovery_code_api_auth_account_login_recovery_code_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Login" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/auth/account/recovery": { "post": { "summary": "Begin Account Recovery", "operationId": "begin_account_recovery_api_auth_account_recovery_post", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object", "title": "Data" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/auth/account/recovery/{identifier}/setup": { "post": { "summary": "Recovery Setup", "operationId": "recovery_setup_api_auth_account_recovery__identifier__setup_post", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Identifier" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/auth/account/recovery/{identifier}/finish": { "post": { "summary": "Recovery Finish", "operationId": "recovery_finish_api_auth_account_recovery__identifier__finish_post", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "type": "string", "title": "Identifier" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Data" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/connect/prepare": { "post": { "summary": "Agent Prepare", "operationId": "agent_prepare_api_connect_prepare_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentKey" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/connect/proof": { "post": { "summary": "Agent Proof", "operationId": "agent_proof_api_connect_proof_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentProof" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/extensions/verification/v1": { "get": { "tags": [ "Agent verification" ], "summary": "Peer Protocol", "operationId": "peer_protocol_extensions_verification_v1_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/verification": { "get": { "tags": [ "Agent verification" ], "summary": "Protocol", "operationId": "protocol_api_verification_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } }, "/api/verification/challenge": { "post": { "tags": [ "Agent verification" ], "summary": "Issue a signed agent key-control challenge", "operationId": "challenge_api_verification_challenge_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChallengeRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/verification/prove": { "post": { "tags": [ "Agent verification" ], "summary": "Verify registered agent key control and current authority", "operationId": "prove_api_verification_prove_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProofRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "Acceptance": { "properties": { "proposal_id": { "type": "string", "title": "Proposal Id" }, "accepted": { "type": "boolean", "title": "Accepted" }, "agreement_digest": { "type": "string", "title": "Agreement Digest" }, "signature": { "type": "string", "maxLength": 200, "title": "Signature" } }, "additionalProperties": false, "type": "object", "required": [ "proposal_id", "accepted", "agreement_digest", "signature" ], "title": "Acceptance" }, "AgentKey": { "properties": { "public_key": { "type": "string", "maxLength": 100, "title": "Public Key" } }, "type": "object", "required": [ "public_key" ], "title": "AgentKey" }, "AgentProof": { "properties": { "signature": { "type": "string", "maxLength": 150, "title": "Signature" } }, "type": "object", "required": [ "signature" ], "title": "AgentProof" }, "Batch": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Acceptance" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Items" } }, "additionalProperties": false, "type": "object", "required": [ "items" ], "title": "Batch" }, "BiometricConsent": { "properties": { "accepted": { "type": "boolean", "title": "Accepted" }, "signature": { "type": "string", "title": "Signature", "default": "" } }, "type": "object", "required": [ "accepted" ], "title": "BiometricConsent" }, "CaseStart": { "properties": { "residence": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Residence" } }, "type": "object", "title": "CaseStart" }, "Ceremony": { "properties": { "kind": { "type": "string", "enum": [ "register", "login", "add" ], "title": "Kind" }, "display_name": { "type": "string", "maxLength": 120, "title": "Display Name", "default": "" }, "jurisdiction": { "type": "string", "title": "Jurisdiction", "default": "" } }, "additionalProperties": false, "type": "object", "required": [ "kind" ], "title": "Ceremony" }, "ChallengeRequest": { "properties": { "agent_id": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Agent Id" }, "audience": { "type": "string", "maxLength": 200, "minLength": 1, "pattern": "^[A-Za-z0-9:/._-]+$", "title": "Audience" }, "nonce": { "type": "string", "pattern": "^[0-9a-f]{32}$", "title": "Nonce" } }, "additionalProperties": false, "type": "object", "required": [ "agent_id", "audience", "nonce" ], "title": "ChallengeRequest" }, "Change": { "properties": { "version": { "type": "integer", "minimum": 0.0, "title": "Version" }, "kind": { "type": "string", "enum": [ "transfer", "replace", "restore", "custodian" ], "title": "Kind" }, "new_owner_id": { "type": "string", "title": "New Owner Id" }, "public_key": { "type": "string", "maxLength": 100, "title": "Public Key" }, "agreement_id": { "type": "string", "title": "Agreement Id" }, "custodian_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custodian Id" } }, "additionalProperties": false, "type": "object", "required": [ "version", "kind", "new_owner_id", "public_key", "agreement_id" ], "title": "Change" }, "Code": { "properties": { "id": { "type": "string", "title": "Id" }, "code": { "type": "string", "maxLength": 100, "title": "Code" } }, "type": "object", "required": [ "id", "code" ], "title": "Code" }, "DisclosureRequest": { "properties": { "agent_id": { "type": "string", "title": "Agent Id" }, "recipient_owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recipient Owner Id" }, "requested_fields": { "items": { "type": "string", "enum": [ "jurisdiction", "owner_kind" ] }, "type": "array", "maxItems": 2, "title": "Requested Fields" } }, "additionalProperties": false, "type": "object", "required": [ "agent_id" ], "title": "DisclosureRequest" }, "DisputeAction": { "properties": { "version": { "type": "integer", "minimum": 0.0, "title": "Version" }, "evidence_ref": { "type": "string", "maxLength": 200, "title": "Evidence Ref" } }, "additionalProperties": false, "type": "object", "required": [ "version", "evidence_ref" ], "title": "DisputeAction" }, "DisputeFile": { "properties": { "target_kind": { "type": "string", "enum": [ "agent", "proposal", "identity_request" ], "title": "Target Kind" }, "target_id": { "type": "string", "title": "Target Id" }, "evidence_ref": { "type": "string", "maxLength": 200, "title": "Evidence Ref" }, "claimant_owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Claimant Owner Id" } }, "additionalProperties": false, "type": "object", "required": [ "target_kind", "target_id", "evidence_ref" ], "title": "DisputeFile" }, "EmailConfirmation": { "properties": { "code": { "type": "string", "maxLength": 43, "minLength": 43, "title": "Code" } }, "additionalProperties": false, "type": "object", "required": [ "code" ], "title": "EmailConfirmation" }, "EmailEnrollment": { "properties": { "address": { "type": "string", "maxLength": 254, "title": "Address" }, "consent": { "type": "boolean", "title": "Consent" } }, "additionalProperties": false, "type": "object", "required": [ "address", "consent" ], "title": "EmailEnrollment" }, "EntityEnrollment": { "properties": { "legal_name": { "type": "string", "maxLength": 120, "title": "Legal Name" }, "jurisdiction": { "type": "string", "title": "Jurisdiction" } }, "additionalProperties": false, "type": "object", "required": [ "legal_name", "jurisdiction" ], "title": "EntityEnrollment" }, "Finish": { "properties": { "challenge_id": { "type": "string", "title": "Challenge Id" }, "credential": { "additionalProperties": true, "type": "object", "title": "Credential" } }, "additionalProperties": false, "type": "object", "required": [ "challenge_id", "credential" ], "title": "Finish" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "Login": { "properties": { "email": { "type": "string", "maxLength": 254, "title": "Email" }, "password": { "type": "string", "maxLength": 256, "title": "Password" }, "code": { "type": "string", "maxLength": 100, "title": "Code" } }, "type": "object", "required": [ "email", "password", "code" ], "title": "Login" }, "LoginPassword": { "properties": { "email": { "type": "string", "maxLength": 254, "title": "Email" }, "password": { "type": "string", "maxLength": 256, "title": "Password" } }, "type": "object", "required": [ "email", "password" ], "title": "LoginPassword" }, "OwnerChange": { "properties": { "version": { "type": "integer", "minimum": 0.0, "title": "Version" }, "legal_name": { "type": "string", "maxLength": 120, "title": "Legal Name" }, "jurisdiction": { "type": "string", "title": "Jurisdiction" } }, "additionalProperties": false, "type": "object", "required": [ "version", "legal_name", "jurisdiction" ], "title": "OwnerChange" }, "Prepare": { "properties": { "owner_id": { "type": "string", "title": "Owner Id" }, "display_name": { "type": "string", "maxLength": 120, "title": "Display Name", "default": "" }, "public_key": { "type": "string", "maxLength": 100, "title": "Public Key" }, "agreement_id": { "type": "string", "title": "Agreement Id" }, "custodian_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custodian Id" }, "username": { "anyOf": [ { "type": "string", "maxLength": 60 }, { "type": "null" } ], "title": "Username" }, "name": { "anyOf": [ { "type": "string", "maxLength": 60 }, { "type": "null" } ], "title": "Name" } }, "additionalProperties": false, "type": "object", "required": [ "owner_id", "public_key", "agreement_id" ], "title": "Prepare" }, "ProofRequest": { "properties": { "challenge": { "additionalProperties": true, "type": "object", "title": "Challenge" }, "signature": { "type": "string", "pattern": "^[A-Za-z0-9_-]{86}$", "title": "Signature" } }, "additionalProperties": false, "type": "object", "required": [ "challenge", "signature" ], "title": "ProofRequest" }, "RecoveryOptions": { "properties": { "recovery_id": { "type": "string", "title": "Recovery Id" } }, "additionalProperties": false, "type": "object", "required": [ "recovery_id" ], "title": "RecoveryOptions" }, "RecoveryStart": { "properties": { "account_id": { "type": "string", "maxLength": 128, "title": "Account Id" }, "compromised_agent_ids": { "items": { "type": "string" }, "type": "array", "maxItems": 100, "title": "Compromised Agent Ids" } }, "additionalProperties": false, "type": "object", "required": [ "account_id" ], "title": "RecoveryStart" }, "Redemption": { "properties": { "token": { "type": "string", "maxLength": 256, "minLength": 32, "title": "Token" } }, "additionalProperties": false, "type": "object", "required": [ "token" ], "title": "Redemption" }, "Rename": { "properties": { "name": { "type": "string", "maxLength": 60, "title": "Name" } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "title": "Rename" }, "RepresentativeRequest": { "properties": { "target_account": { "type": "string", "title": "Target Account" }, "action": { "type": "string", "enum": [ "initial", "appoint", "revoke" ], "title": "Action" }, "permissions": { "items": { "type": "string", "enum": [ "ownership", "transfer", "appoint", "billing", "disclosure", "identity" ] }, "type": "array", "title": "Permissions" }, "version": { "type": "integer", "minimum": 0.0, "title": "Version" } }, "additionalProperties": false, "type": "object", "required": [ "target_account", "action", "permissions", "version" ], "title": "RepresentativeRequest" }, "Revoke": { "properties": { "version": { "type": "integer", "minimum": 0.0, "title": "Version" }, "end_registration": { "type": "boolean", "title": "End Registration", "default": false } }, "additionalProperties": false, "type": "object", "required": [ "version" ], "title": "Revoke" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "registry__app__Approval": { "properties": { "approved_fields": { "items": { "type": "string", "enum": [ "jurisdiction", "owner_kind" ] }, "type": "array", "maxItems": 2, "title": "Approved Fields" }, "token_hash": { "type": "string", "pattern": "^[a-f0-9]{64}$", "title": "Token Hash" }, "expires_at": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expires At" }, "mode": { "type": "string", "enum": [ "single", "repeated" ], "title": "Mode", "default": "repeated" } }, "additionalProperties": false, "type": "object", "required": [ "token_hash" ], "title": "Approval" } } }, "servers": [ { "url": "https://agentauthority.org" } ] }