# Developer guides

Source: https://docs.settlemint.com/docs/developer-guides
Choose the right DALP developer guide for API integration, CLI automation,
platform setup, compliance configuration, asset operations, data feeds, and
operator runbooks.




The developer guides are for teams that build, automate, and operate DALP integrations. Integrating developers use them for API and CLI work. Platform administrators use them for tenant setup, access, and asset operations. Compliance reviewers use them to find the controls, evidence paths, and handoffs that matter before production.

Choose the guide family that matches the surface you need to operate. Start with API integration for application traffic, CLI for scripted operations, platform setup for tenant and administrator work, compliance for identity and provider controls, asset guides for issuance and servicing, feeds for signed values, and operations for production health.

<Mermaid
  chart="`
flowchart TD
Reader[&#x22;Developer or platform operator&#x22;] --> API[&#x22;API integration guides&#x22;]
Reader --> Setup[&#x22;Platform setup guides&#x22;]
Reader --> Assets[&#x22;Asset operations guides&#x22;]
Reader --> Ops[&#x22;Operations runbooks&#x22;]
API --> DAPI[&#x22;DALP API and CLI automation&#x22;]
Setup --> Admin[&#x22;Organizations, roles, API keys, webhooks&#x22;]
Assets --> Tokens[&#x22;Minting, transfers, asset roles, pauses&#x22;]
Ops --> Health[&#x22;Monitoring, upgrades, promotion, recovery&#x22;]
`"
/>

DALP owns the API contracts, CLI behaviour, platform setup flows, and documented control surfaces in this section. Your organisation owns the business policy, administrator assignments, wallet approvals, issuer decisions, compliance provider configuration, feed signers, and runbook approvals that you apply through those surfaces.

These guides cover supported DALP integration work. They do not define legal policy, custody policy, SLA commitments, non-EVM deployment support, bridge operations, privacy posture, or regulator-specific operating procedures. Treat those as organisation-specific controls unless a detail page states the DALP behaviour explicitly.

## What DALP covers [#what-dalp-covers]

The API and CLI can create users, change administrator roles, configure compliance, deploy or service assets, submit feed updates, submit transactions, and inspect platform state when the caller has the required permissions. DALP defines the contracts, command behaviour, permission checks, and returned evidence. Organisation policy decides when those actions are allowed, who may approve them, and which operating controls must exist around them.

| Area             | DALP defines                                                                     | Your organisation defines                                                                                           |
| ---------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| Access           | API contracts, CLI commands, authentication flows, and permission checks         | Which users, service accounts, and operators receive credentials or roles                                           |
| Asset operations | Supported asset creation, servicing, compliance, feed, and transaction workflows | Issuer decisions, approval chains, wallet approvals, and production operating policy                                |
| Evidence         | Indexed state, request logs, events, status checks, and operational read models  | Retention policy, regulator-specific reporting, control testing, and escalation procedures                          |
| Exclusions       | Documented platform behaviour only                                               | Legal policy, custody policy, SLA commitments, bridge operations, privacy posture, and non-EVM deployment decisions |

## Pick the right path [#pick-the-right-path]

| If you need to...                              | Start here                                                                                        | Then read                                                                                                                                                                                                                                     |
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Build a programmatic integration               | [API getting started](/docs/developer-guides/api-integration/getting-started)                     | [API reference guide](/docs/developer-guides/api-integration/api-reference) for the OpenAPI explorer and generated clients                                                                                                                    |
| Understand organization and system scope       | [Organization and system scope](/docs/developer-guides/api-integration/organization-system-scope) | [Platform overview](/docs/developer-guides/platform-setup/platform-overview) for tenant setup context                                                                                                                                         |
| Receive lifecycle events                       | [Events catalogue](/docs/events)                                                                  | Webhook delivery, lifecycle states, payload schemas, and audit evidence                                                                                                                                                                       |
| Automate DALP from scripts or agents           | [CLI overview](/docs/developer-guides/cli/overview)                                               | [Scripting and automation](/docs/developer-guides/cli/scripting)                                                                                                                                                                              |
| Prepare a new tenant or administrator model    | [Platform overview](/docs/developer-guides/platform-setup/platform-overview)                      | [Admin operating model](/docs/developer-guides/platform-setup/admin-operating-model) and [first admin setup](/docs/developer-guides/platform-setup/first-admin-setup)                                                                         |
| Connect identity, KYC, or compliance workflows | [Choose a KYC issuance path](/docs/developer-guides/compliance/choose-kyc-issuance-path)          | [Onboard a compliance provider](/docs/developer-guides/compliance/onboarding-a-provider)                                                                                                                                                      |
| Create and service tokenized assets            | [Create asset](/docs/developer-guides/asset-creation/create-asset)                                | [Mint assets](/docs/developer-guides/asset-servicing/mint-assets)                                                                                                                                                                             |
| Operate prices, NAVs, or signed feed updates   | [Feeds overview](/docs/developer-guides/feeds/overview)                                           | [Submit updates](/docs/developer-guides/feeds/submit-updates)                                                                                                                                                                                 |
| Investigate production operations              | [Transaction tracking](/docs/developer-guides/operations/transaction-tracking)                    | [Blockchain monitoring](/docs/developer-guides/operations/blockchain-monitoring), [system upgrades](/docs/developer-guides/operations/system-upgrades), and [balance reconciliation](/docs/developer-guides/operations/reconciliate-balances) |
| Follow a complete asset-class walkthrough      | [Runbooks](/docs/developer-guides/runbooks/equity-tokenization)                                   | The bond, deposit, equity, fund, and stablecoin runbooks below                                                                                                                                                                                |

## Integration model [#integration-model]

DALP exposes four developer-facing surfaces:

* The API is the integration surface for applications, backend services, and evidence workflows. Call the API to create users, deploy assets, manage compliance, submit transactions, or read indexed platform state.
* The [API reference guide](/docs/developer-guides/api-integration/api-reference) documents the per-deployment OpenAPI explorer served at `/api/v2` on your DALP host. Use it to inspect route groups, request schemas, response shapes, and the versioned specification before generating clients or copying endpoint examples.
* The events catalogue under `/docs/events` is the asynchronous lifecycle-event contract. Use it when downstream systems need signed webhook deliveries, reconciliation inputs, monitoring signals, or audit evidence after DALP activity happens.
* The CLI is the operator and automation surface for local work, CI jobs, scripted administration, and AI agent workflows. Run the CLI when a human or automation process needs a command-line control plane.

Most production integrations combine the API, events, and CLI. Use the API for application traffic, events for asynchronous evidence and reconciliation, and the CLI for setup, inspection, and repeatable operational tasks. Use the detail pages to confirm prerequisites, permissions, side effects, errors, and audit evidence before you run a workflow in production.

## CLI [#cli]

<Cards>
  <Card title="Getting started" href="/docs/developer-guides/cli/getting-started">
    Install the CLI, authenticate, and run your first commands.
  </Card>

  <Card title="Command reference" href="/docs/developer-guides/cli/command-reference">
    Complete reference for all CLI commands across every domain.
  </Card>

  <Card title="Scripting and automation" href="/docs/developer-guides/cli/scripting">
    Use the CLI in shell scripts, CI/CD pipelines, and batch operations.
  </Card>

  <Card title="AI agent integration" href="/docs/developer-guides/cli/ai-agents">
    Connect the CLI to Claude Code, Codex, and OpenCode as an MCP server.
  </Card>
</Cards>

## API integration [#api-integration]

<Cards>
  <Card title="Getting started" href="/docs/developer-guides/api-integration/getting-started">
    Create your first API key and configure the TypeScript client.
  </Card>

  <Card title="API reference guide" href="/docs/developer-guides/api-integration/api-reference">
    Locate the OpenAPI explorer on your DALP deployment, fetch the spec for code generation, and use the API tooling
    safely.
  </Card>

  <Card title="Events catalogue" href="/docs/events">
    Use lifecycle events for webhooks, reconciliation, monitoring, and audit evidence.
  </Card>

  <Card title="Organization and system scope" href="/docs/developer-guides/api-integration/organization-system-scope">
    Understand how DALP separates organization-scoped assets from system-scoped services.
  </Card>

  <Card title="Token lifecycle" href="/docs/developer-guides/api-integration/token-lifecycle">
    Visual flowcharts for token creation, minting, transfers, and burns.
  </Card>

  <Card title="Token holders and transfers" href="/docs/developer-guides/api-integration/token-holders-transfers">
    Query holder balances and execute governed transfer workflows.
  </Card>

  <Card title="Contacts API" href="/docs/developer-guides/api-integration/address-book-contacts">
    Store named wallet recipients for safer transfer and servicing operations.
  </Card>

  <Card title="Error handling" href="/docs/developer-guides/api-integration/error-handling">
    Handle errors correctly with retry strategies and best practices.
  </Card>

  <Card title="Webhook endpoints" href="/docs/developer-guides/api-integration/webhook-endpoints">
    Configure pushed event delivery, payload privacy, retries, and audit proofs.
  </Card>

  <Card title="System paymasters" href="/docs/developer-guides/api-integration/system-paymasters">
    List paymasters, check funding, manage sponsorship, and rotate signer keys.
  </Card>

  <Card title="SDK" href="/docs/developer-guides/api-integration/sdk">
    Install the TypeScript SDK and choose the right client setup for your integration.
  </Card>

  <Card title="API monitoring" href="/docs/developer-guides/api-integration/api-monitoring">
    Query request volume, latency, error rates, request logs, and live API activity.
  </Card>

  <Card title="Token documents" href="/docs/developer-guides/api-integration/token-documents">
    Attach, fetch, and validate token document metadata through the API.
  </Card>

  <Card title="XvP settlement flows" href="/docs/developer-guides/api-integration/xvp-settlement-flows">
    Integrate settlement preparation, execution, cancellation, and status checks.
  </Card>

  <Card title="Smart wallet multisig approvals" href="/docs/developer-guides/api-integration/smart-wallet-approvals">
    Check smart-wallet approval requirements before executing governed actions.
  </Card>

  <Card title="Error code reference" href="/docs/developer-guides/api-integration/error-code-reference">
    Map DALP error codes to operator action, retry handling, and support evidence.
  </Card>

  <Card title="Asset decimals" href="/docs/developer-guides/api-integration/asset-decimals">
    Format asset amounts correctly using decimal configuration.
  </Card>
</Cards>

## Platform setup [#platform-setup]

<Cards>
  <Card title="Platform overview" href="/docs/developer-guides/platform-setup/platform-overview">
    API-based platform setup and administrator role management.
  </Card>

  <Card title="First admin setup" href="/docs/developer-guides/platform-setup/first-admin-setup">
    Initialize your platform with the first administrator account.
  </Card>

  <Card title="Add administrators" href="/docs/developer-guides/platform-setup/add-admins">
    Grant administrative permissions to users in your organization.
  </Card>

  <Card title="Admin operating model" href="/docs/developer-guides/platform-setup/admin-operating-model">
    Plan administrator responsibilities, role assignment, and operational ownership.
  </Card>

  <Card title="Change admin roles" href="/docs/developer-guides/platform-setup/change-admin-roles">
    Grant or revoke platform administrator roles.
  </Card>
</Cards>

## User management [#user-management]

<Cards>
  <Card title="Create users" href="/docs/developer-guides/user-management/create-users">
    Create platform users with automatic wallet and identity setup.
  </Card>

  <Card title="Register user" href="/docs/developer-guides/user-management/register-user">
    Register users in the identity registry for compliance tracking.
  </Card>
</Cards>

## Compliance [#compliance]

<Cards>
  <Card title="Choose a KYC issuance path" href="/docs/developer-guides/compliance/choose-kyc-issuance-path">
    Decide whether to issue manual KYC claims or connect a compliance provider.
  </Card>

  <Card title="Configure trusted issuers" href="/docs/developer-guides/compliance/configure-trusted-issuers">
    Configure entities authorized to issue verifications.
  </Card>

  <Card title="Verify KYC" href="/docs/developer-guides/compliance/verify-kyc">
    Issue KYC verifications to registered users.
  </Card>

  <Card title="Smart identity verification" href="/docs/developer-guides/compliance/smart-identity-verification">
    Configure identity verification compliance modules.
  </Card>

  <Card title="Onboard a compliance provider" href="/docs/developer-guides/compliance/onboarding-a-provider">
    Add a provider, provision a provider issuer EOA, and configure webhooks.
  </Card>

  <Card title="Collateral requirement" href="/docs/developer-guides/compliance/collateral">
    Configure collateral ratios and backing requirements.
  </Card>
</Cards>

## Asset creation [#asset-creation]

<Cards>
  <Card title="Create asset" href="/docs/developer-guides/asset-creation/create-asset">
    Deploy a new tokenized asset on the blockchain.
  </Card>
</Cards>

## Asset servicing [#asset-servicing]

<Cards>
  <Card title="Change asset admin roles" href="/docs/developer-guides/asset-servicing/change-asset-admin-roles">
    Grant or revoke administrator roles for specific assets.
  </Card>

  <Card title="Mint assets" href="/docs/developer-guides/asset-servicing/mint-assets">
    Issue new units to investors.
  </Card>

  <Card title="Forced transfer" href="/docs/developer-guides/asset-servicing/forced-transfer">
    Administratively move assets between wallets for compliance or recovery.
  </Card>

  <Card title="Pause and unpause assets" href="/docs/developer-guides/asset-servicing/pause-unpause-asset">
    Enable or disable all transfers for an asset.
  </Card>
</Cards>

## Feeds [#feeds]

<Cards>
  <Card title="Overview" href="/docs/developer-guides/feeds/overview">
    On-chain data feeds for price reporting, NAV tracking, and oracle data.
  </Card>

  <Card title="Create feeds" href="/docs/developer-guides/feeds/create-feeds">
    Deploy issuer-signed feeds, aggregator adapters, and register external feeds.
  </Card>

  <Card title="Submit updates" href="/docs/developer-guides/feeds/submit-updates">
    Submit signed feed updates with EIP-712 typed data and nonce management.
  </Card>

  <Card title="Read data" href="/docs/developer-guides/feeds/read-data">
    Query latest values, historical rounds, and check feed staleness.
  </Card>
</Cards>

## Operations [#operations]

<Cards>
  <Card title="Transaction tracking" href="/docs/developer-guides/operations/transaction-tracking">
    Check transaction status after timeout errors.
  </Card>

  <Card title="Blockchain monitoring" href="/docs/developer-guides/operations/blockchain-monitoring">
    Monitor chain RPC and indexer health from the API or CLI.
  </Card>

  <Card title="System upgrades" href="/docs/developer-guides/operations/system-upgrades">
    Review upgrade status and run controlled system upgrades.
  </Card>

  <Card title="Durable Execution Engine recovery" href="/docs/developer-guides/operations/durable-execution-engine-recovery">
    Recover blocked Durable Execution Engine workflows and clean stale deployments.
  </Card>

  <Card title="Reconcile balances" href="/docs/developer-guides/operations/reconciliate-balances">
    Compare on-chain state with your internal records.
  </Card>
</Cards>

## Runbooks [#runbooks]

The [top-level runbook shelf](/docs/runbooks) is the authoritative index for DALP runbooks. This shelf keeps developer runbooks, compliance configuration runbooks, and API-led scenario walkthroughs near the integration material they depend on.

Use these pages when the operation starts from an API, CLI, script, or integration test. Use the [user-guide runbook shelf](/docs/user-guides/introduction#runbooks) when the same scenario needs console steps. The equity tokenization walkthrough appears in both shelves because the API and UI versions serve different readers.

<Cards>
  <Card title="Equity tokenization through APIs" href="/docs/developer-guides/runbooks/equity-tokenization">
    API-led walkthrough for multi-organization equity tokenization.
  </Card>

  <Card title="Bonds" href="/docs/developer-guides/runbooks/create-mint-bonds">
    Create debt instruments with coupon schedules and maturity dates.
  </Card>

  <Card title="Deposits" href="/docs/developer-guides/runbooks/create-mint-deposits">
    Issue deposit certificates with interest accrual.
  </Card>

  <Card title="Equities" href="/docs/developer-guides/runbooks/create-mint-equities">
    Deploy equity tokens with dividend distribution.
  </Card>

  <Card title="Funds" href="/docs/developer-guides/runbooks/create-mint-funds">
    Launch fund tokens with NAV tracking.
  </Card>

  <Card title="Stablecoins" href="/docs/developer-guides/runbooks/create-mint-stablecoins">
    Create collateral-backed stablecoins.
  </Card>

  <Card title="Configure equity collateral" href="/docs/developer-guides/runbooks/configure-equity-collateral">
    Add collateral requirements using the Compliance Module API.
  </Card>
</Cards>