> ## Documentation Index > Fetch the complete documentation index at: https://docs.apostra.com/llms.txt > Use this file to discover all available pages before exploring further. # Retain the first free provider account > Atomically map the first customer-local provider account and retain the unclaimed WorkOS Agent Registration as BOUND_FREE. Interchange derives this exact zero-spend lifecycle capability from the verified Agent Registration and its activation state; no separate WorkOS permission or identity claim is required. ## OpenAPI ````yaml /v2/buyer-api-v2.yaml post /activation/provider-binding openapi: 3.0.0 info: title: Scope3 Buyer API version: 2.0.0 description: |- REST API for advertisers to manage advertisers, campaigns, and reporting. ## Authentication All endpoints require a Bearer token in the Authorization header: ``` Authorization: Bearer your-api-key ``` ## Base URL `https://api.interchange.io/api/v2/buyer` ## For AI Agents AI agents can use the MCP endpoint at `/mcp/v2/buyer` with three tools: - `initialize`: Start an MCP session - `api_call`: Make REST API calls - `ask_about_capability`: Learn about API features servers: - url: https://api.interchange.io/api/v2/buyer description: Production server security: [] tags: - name: Signup description: Request reviewed access to Interchange - name: Account description: Account management, service tokens, and preferences - name: Asks description: >- What you are waiting on Scope3 for — support, product, and supply asks in one list - name: Advertisers description: Manage advertisers - name: Product Discovery description: Discover and select products - name: Campaigns description: Manage advertising campaigns - name: Creatives description: Build, manage, and sync campaign creatives via AdCP Creative Protocol - name: Reporting description: Access performance metrics - name: Event Sources description: >- Manage event source configurations and log conversion/marketing events for attribution - name: Property Lists description: Validate property lists against AAO registry - name: Sales Agents description: View and connect sales agents - name: Measurement description: Measurement sources, records, context, and freshness - name: Syndication description: Syndicate resources to ADCP agents - name: Tasks description: Track async operation status - name: Buyer Billing description: >- Consolidated invoicing for buyers — invoices and pending invoice items issued by Scope3 across the buyer customer. - name: MCP description: Model Context Protocol endpoints for AI agents paths: /activation/provider-binding: post: tags: - Account summary: Retain the first free provider account description: >- Atomically map the first customer-local provider account and retain the unclaimed WorkOS Agent Registration as BOUND_FREE. Interchange derives this exact zero-spend lifecycle capability from the verified Agent Registration and its activation state; no separate WorkOS permission or identity claim is required. operationId: retainBoundFreeProviderAccount requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RetainBoundFreeAccountBody' responses: '200': description: Retain the first free provider account content: application/json: schema: $ref: '#/components/schemas/RetainBoundFreeAccountResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- An active UNBOUND_FREE WorkOS Agent Registration is required, or BOUND_FREE already retains its one account. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] components: schemas: RetainBoundFreeAccountBody: type: object properties: advertiserId: type: string pattern: ^\d+$ connectionId: type: string pattern: ^\d+$ accountId: type: string pattern: ^\d+$ sourceId: type: string minLength: 1 required: - advertiserId - connectionId - accountId additionalProperties: false RetainBoundFreeAccountResponse: type: object properties: previousState: type: string enum: - unbound_free - bound_free activation: $ref: '#/components/schemas/BuyerActivationResponse' bindingRef: type: string pattern: ^provider-binding:sha256:[a-f0-9]{64}$ description: >- Privacy-safe stable reference for the retained provider mapping. It is not a provider or database identifier. cleanupCancelled: type: boolean enum: - true required: - previousState - activation - bindingRef - cleanupCancelled additionalProperties: false ErrorResponse: type: object properties: data: type: string nullable: true enum: - null error: $ref: '#/components/schemas/ApiError' required: - data - error additionalProperties: false description: Standard error response BuyerActivationResponse: type: object properties: schemaVersion: type: string enum: - '1.3' activationId: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: >- Stable activation lineage retained across retries and identity claim. workloadId: type: string pattern: ^agent-registration:\d+$ description: Stable Interchange workload identifier for this registration. state: type: string enum: - unbound_free - bound_free - customer_bound description: >- Agent Registration attachment state only. customer_bound does not imply identity proof, Terms acceptance, payment authority, or live eligibility; read Buyer Setup for operation-specific capabilities. expiresAt: nullable: true description: >- Expiry of the unbound sandbox registration. Null after customer binding. type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ allowance: $ref: '#/components/schemas/BuyerActivationAllowance' account: nullable: true deprecated: true description: >- Deprecated schema 1.2 compatibility projection for customer-bound clients. It is never an authorization source; use Buyer Setup capabilities. Null for free workloads and whenever the claimed customer authority is absent. allOf: - $ref: '#/components/schemas/BuyerActivationCompatibilityAccount' claim: type: object properties: available: type: boolean description: >- Whether this unbound registration may begin an optional WorkOS claim ceremony. preservesActivationId: type: boolean enum: - true required: - available - preservesActivationId additionalProperties: false required: - schemaVersion - activationId - workloadId - state - expiresAt - allowance - account - claim additionalProperties: false description: >- Stable activation lineage, current workload attachment state, and the bounded authority available to a registered buyer agent. Human and agent principals use Buyer Setup for the same Account capability decisions after binding. ApiError: type: object properties: code: type: string description: Machine-readable error code message: type: string description: Human-readable error message field: description: Field path associated with the error type: string details: description: Additional error context type: object additionalProperties: {} required: - code - message additionalProperties: false description: Structured error object BuyerActivationAllowance: type: object properties: ttlDays: nullable: true description: >- Unbound sandbox retention period. Null after the first provider binding retains BOUND_FREE or the workload becomes customer-bound. type: number enum: - 30 cleanup: nullable: true description: >- Cleanup policy for an unbound sandbox. Null after the first provider binding retains BOUND_FREE or the workload becomes customer-bound. type: string enum: - automatic_at_expiry spendCap: $ref: '#/components/schemas/BuyerActivationSpendCap' grants: type: array items: type: string minLength: 1 description: >- Current technical grants. These are a ceiling and do not themselves grant commercial standing or payment authority. prohibitedOperations: type: array items: type: string minLength: 1 description: Operations explicitly unavailable to the current activation state. required: - ttlDays - cleanup - spendCap - grants - prohibitedOperations additionalProperties: false BuyerActivationCompatibilityAccount: type: object properties: accessPosture: type: string enum: - SANDBOX_ONLY - LIVE_ELIGIBLE source: type: string enum: - EXPLICIT - LEGACY_COMPATIBILITY - FAIL_SAFE_DEFAULT required: - accessPosture - source additionalProperties: false BuyerActivationSpendCap: type: object properties: amountMinor: nullable: true description: >- Maximum committed spend imposed by the free activation in currency minor units. It remains zero for BOUND_FREE and becomes null only after the workload is customer-bound, when operation-specific Buyer Setup capabilities apply. Null is not an unlimited-spend grant. type: integer minimum: 0 maximum: 9007199254740991 currency: type: string enum: - USD required: - amountMinor - currency additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer description: API key or access token ````