# CryptoSwift Developer Portal

The CryptoSwift Developer Portal documents how to integrate with CryptoSwift APIs for crypto Travel Rule compliance, webhook notifications, incoming and outgoing transaction workflows, and self-hosted wallet verification.

## Canonical API resources

- OpenAPI spec: https://api.cryptoswift.eu/api-json
- Production API: https://api.cryptoswift.eu
- Test API: https://api-dev.cryptoswift.eu
- API agent manifest: https://api.cryptoswift.eu/.well-known/cryptoswift-agent.json

## Authentication

CryptoSwift API requests use API key authentication with the `X-Api-Key` request header.

Keep API keys on the server side. Do not hardcode API keys, commit them to source control, expose them in frontend code, or print them in logs. Load credentials from environment variables or a secrets manager.

## Core integration flows

1. Outgoing transactions
   - Create outgoing Travel Rule messages.
   - Support post-transaction and, where needed, pre-transaction decision workflows.
   - Track delivery and response statuses through webhooks or polling.

2. Incoming transaction handling and responses
   - Receive incoming Travel Rule messages.
   - Reconcile blockchain, counterparty, and beneficiary data with internal records.
   - Confirm or decline incoming messages through backend API calls.

3. Webhook notifications
   - Register a backend webhook endpoint.
   - Handle transaction and wallet verification events.
   - Verify webhook signatures and return 2xx responses after successful processing.

4. Self-hosted wallet verification
   - Create wallet verification sessions.
   - Use the hosted flow, widget, or API flow depending on the product experience.
   - Process completion events server-side and reconcile verification status.

## AI coding agent guides

AI coding agents should start with these two pages before implementing:

- AI Agent Integration: https://dev.cryptoswift.eu/docs/ai/agent-integration
- AI Agent Prompts: https://dev.cryptoswift.eu/docs/ai/agent-prompts

Use the AI Agent Integration page for the recommended implementation workflow, checklist, security rules, and source-of-truth links. Use AI Agent Prompts when asking an agent to implement a full integration, a single core flow, SDK generation, or a production readiness review.

## Recommended docs paths

- https://dev.cryptoswift.eu/docs/fundamentals/overview
- https://dev.cryptoswift.eu/docs/fundamentals/test-environment
- https://dev.cryptoswift.eu/docs/integration-guides/getting-started
- https://dev.cryptoswift.eu/docs/integration-guides/outgoing-transactions
- https://dev.cryptoswift.eu/docs/integration-guides/incoming-transactions
- https://dev.cryptoswift.eu/docs/integration-guides/webhooks
- https://dev.cryptoswift.eu/docs/integration-guides/self-hosted-wallet-verification
- https://dev.cryptoswift.eu/docs/ai/agent-prompts
- https://dev.cryptoswift.eu/docs/ai/agent-integration
- https://dev.cryptoswift.eu/docs/api-reference/generate-sdk
- https://dev.cryptoswift.eu/docs-index.json

## Agent guidance

Use the OpenAPI spec as the source of truth for endpoint shapes. Use the AI coding agent guides for implementation workflow and prompt structure. Use the integration guide pages as the source of truth for workflow sequencing. Build and validate against the test API before using production. Avoid duplicating the existing integration guides in generated docs or code comments; link to the relevant docs path instead.