# Swapnice

- [Partner SDK](https://swapnice.mintlify.app/partners/introduction.md): Install the Swapnice Partner SDK and start a consented integration.
- [Environments](https://swapnice.mintlify.app/partners/environments.md): Development and production Partner API hosts, what is isolated between them, and which URL partners should call.
- [SDK versus API](https://swapnice.mintlify.app/partners/sdk-vs-api.md): Where the Swapnice SDK and Partner API overlap, and where their capabilities differ.
- [Authentication](https://swapnice.mintlify.app/partners/authentication.md): OAuth 2.1, PKCE, scopes, tokens, and how partner apps authenticate to the Swapnice API.
- [Consent and account linking](https://swapnice.mintlify.app/partners/consent.md): How a partner customer is linked to a Swapnice account, which purposes exist, and how revocation works.
- [Integration and sample code](https://swapnice.mintlify.app/partners/integration.md): Implementation requirements and end-to-end examples for the Swapnice SDK and Partner API.
- [Events and intent ontology](https://swapnice.mintlify.app/partners/events-and-intents.md): How to shape partner activity into Swapnice events, claims, and intent categories.
- [Entries and ontologies](https://swapnice.mintlify.app/partners/catalog.md): How partners describe products, SKUs, and collectibles so events and intents attach to a shared catalog.
- [Webhooks](https://swapnice.mintlify.app/partners/webhooks.md): Register endpoints, verify signatures, and handle Swapnice async events.
- [Example use cases](https://swapnice.mintlify.app/partners/use-cases.md): Worked integration scenarios for product, retail, and catalog partners.
- [Data collection](https://swapnice.mintlify.app/partners/data-collection.md): What the Swapnice SDK observes, how it is collected, when it is transmitted, and what is never sent.
- [Outputs](https://swapnice.mintlify.app/partners/outputs.md): Profiles, claims, intent scores, and sample responses partners receive from the SDK and API.
- [Architecture and data flow](https://swapnice.mintlify.app/partners/architecture.md): End-to-end path from a consumer action in a partner app to a Swapnice profile or intent.
- [Sandbox and testing](https://swapnice.mintlify.app/partners/sandbox.md): Development and Production hosts, credentials, and the expected implementation and test process for a Swapnice pilot.
- [Request walkthrough](https://swapnice.mintlify.app/partners/request-walkthrough.md): Ordered sandbox calls from OAuth through profile read, including the payloads and fields that usually trip teams up.
- [What a pilot enables](https://swapnice.mintlify.app/partners/pilot.md): What integrating the Swapnice SDK unlocks in the partner product.
- [API overview](https://swapnice.mintlify.app/partners/api-overview.md): Partner API contract, authentication, and every public route.
- [OAuth](https://swapnice.mintlify.app/partners/api/oauth.md): Authorization-code + PKCE endpoints for the Partner API.
- [Get authorization server metadata](https://swapnice.mintlify.app/partners/api-reference/oauth-metadata.md): Discover authorize, token, introspect, and revoke URLs. No authentication.
- [Create an authorization code](https://swapnice.mintlify.app/partners/api-reference/oauth-authorize.md): JSON PKCE authorize used by the SDK and sandbox walkthrough.
- [Start browser authorization](https://swapnice.mintlify.app/partners/api-reference/oauth-authorize-browser.md): Browser-facing authorize page for hosted connect UX.
- [Exchange or refresh a token](https://swapnice.mintlify.app/partners/api-reference/oauth-token.md): Trade an authorization code or refresh token for a Bearer access token.
- [Introspect a token](https://swapnice.mintlify.app/partners/api-reference/oauth-introspect.md): Confirm a token is active and inspect its scopes.
- [Revoke a token](https://swapnice.mintlify.app/partners/api-reference/oauth-revoke.md): Invalidate an access or refresh token.
- [Apps](https://swapnice.mintlify.app/partners/api/apps.md): Register and update a partner OAuth application.
- [Create a partner app](https://swapnice.mintlify.app/partners/api-reference/apps-create.md): Register an OAuth application. Returns the client secret once.
- [Get a partner app](https://swapnice.mintlify.app/partners/api-reference/apps-get.md): Read app configuration, scopes, and redirect URIs.
- [Update a partner app](https://swapnice.mintlify.app/partners/api-reference/apps-update.md): Change redirect URIs, scopes, consent purposes, or status.
- [Connection sessions](https://swapnice.mintlify.app/partners/api/connections.md): Short-lived sessions that link a partner customer to a Swapnice account.
- [Create a connection session](https://swapnice.mintlify.app/partners/api-reference/connections-create.md): Start the Plaid-Link-style account linking flow.
- [Get a connection session](https://swapnice.mintlify.app/partners/api-reference/connections-get.md): Poll session status until authorized, completed, expired, or revoked.
- [Cancel a connection session](https://swapnice.mintlify.app/partners/api-reference/connections-delete.md): Revoke an unused linking session.
- [Consent](https://swapnice.mintlify.app/partners/api/consent.md): Grant, list, inspect, and revoke purpose-limited consent receipts.
- [Create a consent receipt](https://swapnice.mintlify.app/partners/api-reference/consent-create.md): Record purpose grants after the user accepts.
- [List consent receipts](https://swapnice.mintlify.app/partners/api-reference/consent-list.md): List receipts for a partner customer.
- [Revoke consent](https://swapnice.mintlify.app/partners/api-reference/consent-revoke.md): Revoke one or more purposes. Ingest and purpose-scoped reads fail closed immediately.
- [Get effective consent](https://swapnice.mintlify.app/partners/api-reference/consent-effective.md): See which purposes are currently granted for a customer.
- [Customers](https://swapnice.mintlify.app/partners/api/customers.md): Create and read the partner-scoped customer record.
- [Create or upsert a customer](https://swapnice.mintlify.app/partners/api-reference/customers-upsert.md): Create the partner-scoped user. Body field is external_id, not customer_id.
- [Get a customer](https://swapnice.mintlify.app/partners/api-reference/customers-get.md): Read the partner customer record Swapnice assigned.
- [Events](https://swapnice.mintlify.app/partners/api/events.md): Ingest consented activity and read processing status.
- [Ingest an event](https://swapnice.mintlify.app/partners/api-reference/events-ingest.md): Accept one consented activity event. Idempotency-Key is required.
- [Ingest a batch of events](https://swapnice.mintlify.app/partners/api-reference/events-batch.md): Send 1–100 events. Ordering is guaranteed per customer, not across customers.
- [Get event status](https://swapnice.mintlify.app/partners/api-reference/events-get.md): Read processing status for an accepted event.
- [Profiles](https://swapnice.mintlify.app/partners/api/profiles.md): Synchronous, consent-aware reads for resolved facts, claims, and intents.
- [Get a resolved profile](https://swapnice.mintlify.app/partners/api-reference/profiles-get.md): Synchronous facts with confidence, evidence, and alternatives.
- [List claims](https://swapnice.mintlify.app/partners/api-reference/profiles-claims.md): Unresolved evidence behind the resolved profile.
- [List intents](https://swapnice.mintlify.app/partners/api-reference/profiles-intents.md): Outcome, habit, affiliate, sentiment, and activation scores.
- [Entries and ontologies](https://swapnice.mintlify.app/partners/api/catalog.md): Catalog objects of intent and the field maps that validate them.
- [List ontologies](https://swapnice.mintlify.app/partners/api-reference/ontologies-list.md): List catalog field maps available to the partner.
- [Get an ontology](https://swapnice.mintlify.app/partners/api-reference/ontologies-get.md): Read the field map, types, and identity fields for one ontology.
- [Rebuild ontology fields](https://swapnice.mintlify.app/partners/api-reference/ontologies-rebuild.md): Regenerate filter metadata after a bulk entry import.
- [Create or upsert an entry](https://swapnice.mintlify.app/partners/api-reference/entries-upsert.md): Add a catalog object events can reference.
- [Get an entry](https://swapnice.mintlify.app/partners/api-reference/entries-get.md): Read one catalog object.
- [Replace an entry](https://swapnice.mintlify.app/partners/api-reference/entries-update.md): PUT uses the same validation as create. Identity fields must still match.
- [Webhooks](https://swapnice.mintlify.app/partners/api/webhooks.md): Register HTTPS receivers for async Swapnice events.
- [Register a webhook endpoint](https://swapnice.mintlify.app/partners/api-reference/webhooks-create.md): Create a receiver. The signing secret is shown once.
- [List webhook endpoints](https://swapnice.mintlify.app/partners/api-reference/webhooks-list.md): List registered receivers for this app.
- [Get workflow status](https://swapnice.mintlify.app/partners/api-reference/workflows-get.md): Poll async work such as consent revocation or field rebuilds.
- [Swapnice documentation](https://swapnice.mintlify.app/introduction.md): Start with the Partner SDK and API, or browse consumer app guides for personas, badges, and inventory.
- [Personas](https://swapnice.mintlify.app/swapnice-features/personas.md): Engaging Customisable AI Characters
- [Swap Badge](https://swapnice.mintlify.app/swapnice-features/swapbadge.md): NFC microchip that securely stores an item's history, identity details, and swapp data.
- [Switems](https://swapnice.mintlify.app/swapnice-features/switems.md): Digitally Enhanced Items
- [Inventory](https://swapnice.mintlify.app/swapnice-features/inventory.md): Track and manage your Hubs in your Inventory.
- [Hubs](https://swapnice.mintlify.app/swapnice-features/hubs.md): Connect with Switems and Personas in Hubs.
- [Swapps](https://swapnice.mintlify.app/swapnice-features/swapps.md): Digital Brand-Specific Experiences through Interactions with Switems, Personas, and Swap badges.
- [Swapp Store](https://swapnice.mintlify.app/swapnice-features/swapp-store.md): Buy and sell Swapps for Switems.
- [Listings](https://swapnice.mintlify.app/swapnice-features/listings.md): Create and manage listings for your items.
- [Transactions](https://swapnice.mintlify.app/swapnice-features/transactions.md): Secure and Transparent Transactions
- [Swap Wallet](https://swapnice.mintlify.app/swapnice-features/swap-wallet.md)
- [Contacts](https://swapnice.mintlify.app/swapnice-features/contacts.md): Connect with other users and manage your contacts.
- [Quick Start Guide - Swapnice](https://swapnice.mintlify.app/swapnice-quick-start/quick_start_guide.md): Swapnice guide for users to quickly get up and running.
- [Activate Swap Badge](https://swapnice.mintlify.app/swapnice-quick-start/activate_swap_badge.md): Step-by-step guide on activating Swap Badges.

## OpenAPI Specs

- [openapi](/openapi.yaml)