# API integration

Source: https://docs.settlemint.com/docs/developer-guides/api-integration
Choose the right DALP API integration page for authentication, OpenAPI client generation, request headers, errors, webhooks, token workflows, durable workflow recovery, smart wallets, and XvP settlement flows.



DALP API integration docs are grouped by the job you are doing and by documentation type. Start with the how-to path for authentication and generated clients, use concept pages to understand integration boundaries, and keep reference pages nearby when you wire production flows.

## Start here [#start-here]

| Type      | If you need to                                          | Read                                                                      | Outcome                                                             |
| --------- | ------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------- |
| How-to    | Create an API key and make the first authenticated call | [Getting started](/docs/developer-guides/api-integration/getting-started) | Configure API key authentication and a generated TypeScript client. |
| How-to    | Choose SDK generation and client conventions            | [SDK integration](/docs/developer-guides/api-integration/sdk)             | Generate and organise a typed client around the OpenAPI contract.   |
| Reference | Generate clients or inspect endpoint contracts          | [API reference](/docs/developer-guides/api-integration/api-reference)     | Use the OpenAPI explorer and specification contract.                |

## Core integration model [#core-integration-model]

| Type      | If you need to                                                                                          | Read                                                                                                        | Outcome                                                                           |
| --------- | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| Reference | Configure shared headers for acting participants, execution wallets, idempotency, and transaction speed | [Request headers](/docs/developer-guides/api-integration/request-headers)                                   | Send headers only on routes that support them, with the right fallback behaviour. |
| Reference | Discover organisations, systems, networks, implementations, and contract factories                      | [System directory API](/docs/developer-guides/api-integration/directory)                                    | Resolve the platform directory data needed before calling scoped API surfaces.    |
| Concept   | Scope integrations across organisations and systems                                                     | [Organisation and system scope](/docs/developer-guides/api-integration/organization-system-scope)           | Keep API keys, organisations, systems, and permission boundaries aligned.         |
| Concept   | Reuse operational patterns across API integrations                                                      | [Operational integration patterns](/docs/developer-guides/api-integration/operational-integration-patterns) | Plan retries, idempotency, transaction tracking, and production handoffs.         |

## Token and asset APIs [#token-and-asset-apis]

| Type      | If you need to                        | Read                                                                                                                                                                                                                                                                                                                                                                                                                                                | Outcome                                                                                          |
| --------- | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| Reference | Manage token lifecycle operations     | [Token lifecycle](/docs/developer-guides/api-integration/token-lifecycle)                                                                                                                                                                                                                                                                                                                                                                           | Create assets, change supply, manage holders, documents, metadata, permits, and decimals.        |
| Reference | Register deployed EVM tokens          | [External tokens](/docs/developer-guides/api-integration/external-tokens)                                                                                                                                                                                                                                                                                                                                                                           | Register and list already deployed EVM tokens inside DALP.                                       |
| Reference | Attach and retrieve token documents   | [Token documents](/docs/developer-guides/api-integration/token-documents)                                                                                                                                                                                                                                                                                                                                                                           | Manage document links and metadata for asset records.                                            |
| Reference | Work with token holders and transfers | [Token holders and transfers](/docs/developer-guides/api-integration/token-holders-transfers)                                                                                                                                                                                                                                                                                                                                                       | Inspect holder balances and transfer-related API surfaces.                                       |
| Reference | Read indexed token events             | [Token events](/docs/developer-guides/api-integration/token-events)                                                                                                                                                                                                                                                                                                                                                                                 | Query token activity, wallet-scoped event history, facets, pagination, and dapp table behaviour. |
| Reference | Resolve asset pricing and statistics  | [Token price resolution](/docs/developer-guides/api-integration/token-price-resolution), [Token volume statistics](/docs/developer-guides/api-integration/token-volume-statistics), [Yield coverage statistics](/docs/developer-guides/api-integration/yield-coverage-statistics), [Portfolio statistics](/docs/developer-guides/api-integration/portfolio-statistics), and [Asset decimals](/docs/developer-guides/api-integration/asset-decimals) | Read pricing, volume, yield, portfolio, and decimal precision surfaces.                          |
| Reference | Integrate XvP settlement flows        | [XvP settlement flows](/docs/developer-guides/api-integration/xvp-settlement-flows)                                                                                                                                                                                                                                                                                                                                                                 | Integrate hold, release, settlement, and cancellation workflows for XvP settlement.              |

## Wallets/account abstraction [#walletsaccount-abstraction]

| Type      | If you need to                               | Read                                                                                                                                                                                                                                                          | Outcome                                                                           |
| --------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| Concept   | Discover smart accounts and approvals        | [Smart wallets](/docs/developer-guides/api-integration/smart-wallets), [Smart wallet approvals](/docs/developer-guides/api-integration/smart-wallet-approvals), and [Smart wallet thresholds](/docs/developer-guides/api-integration/smart-wallet-thresholds) | Discover wallets, review approval requirements, and inspect threshold settings.   |
| Reference | Recover wallet identity links                | [Identity recovery](/docs/developer-guides/api-integration/identity-recovery)                                                                                                                                                                                 | Inspect identity recovery surfaces for smart-account integrations.                |
| Reference | Read native account balances                 | [Account native balances](/docs/developer-guides/api-integration/account-native-balances)                                                                                                                                                                     | Read native asset balances for accounts.                                          |
| Reference | Discover account abstraction network support | [Account abstraction transaction relay](/docs/developer-guides/api-integration/bundler)                                                                                                                                                                       | Discover the active chain and ERC-4337 EntryPoint support.                        |
| Reference | Operate sponsored gas settings               | [Gas sponsorship paymasters](/docs/developer-guides/api-integration/system-paymasters)                                                                                                                                                                        | Inspect paymaster balances, deposits, sponsorship configuration, and signer keys. |

## Compliance APIs [#compliance-apis]

| Type      | If you need to                            | Read                                                                                  | Outcome                                                                 |
| --------- | ----------------------------------------- | ------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| Reference | Reuse compliance templates                | [Compliance templates](/docs/developer-guides/api-integration/compliance-templates)   | Apply reusable compliance rules to asset and transfer workflows.        |
| Reference | Configure module-backed transfer controls | [Compliance modules](/docs/developer-guides/api-integration/compliance-modules)       | Configure compliance modules that enforce transfer controls.            |
| Reference | Work with address-book contacts           | [Address book contacts](/docs/developer-guides/api-integration/address-book-contacts) | Review contact data that supports allowlist and counterparty workflows. |
| How-to    | Upload KYC documents                      | [KYC document uploads](/docs/developer-guides/api-integration/kyc-document-uploads)   | Send the document files required by KYC workflows.                      |

## Reporting, monitoring, and recovery [#reporting-monitoring-and-recovery]

| Type      | If you need to                                            | Read                                                                                                                  | Outcome                                                                                  |
| --------- | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| Concept   | Monitor API operations                                    | [API monitoring](/docs/developer-guides/api-integration/api-monitoring)                                               | Track health, latency, and operational signals around API integrations.                  |
| Reference | Map reporting and audit evidence surfaces                 | [Reporting and audit access](/docs/developer-guides/api-integration/reporting-audit-access)                           | Choose holder, event, action, export, webhook, and transaction evidence for reporting.   |
| Reference | Plan operator recovery for blocked durable workflow state | [Durable Execution Engine recovery](/docs/developer-guides/operations/durable-execution-engine-recovery)              | Check when recovery actions are appropriate before changing workflow state.              |
| Reference | Call Durable Execution Engine operator routes             | [Durable Execution Engine operator API](/docs/developer-guides/api-integration/durable-execution-engine-operator-api) | Inspect route bodies, success payloads, component statuses, and retry-blocked behaviour. |

## Webhooks/integrations [#webhooksintegrations]

| Type      | If you need to          | Read                             | Outcome                                                                                                |
| --------- | ----------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------ |
| Reference | Receive platform events | [Events catalogue](/docs/events) | Configure webhook destinations, then use the event reference for lifecycle states and payload schemas. |

## Error/API reference [#errorapi-reference]

| Type      | If you need to                     | Read                                                                                          | Outcome                                                                         |
| --------- | ---------------------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| How-to    | Handle API and OpenAPI errors      | [Error handling](/docs/developer-guides/api-integration/error-handling)                       | Distinguish request validation, platform errors, and error-code recovery paths. |
| Reference | Look up API error identifiers      | [API error reference](/docs/developer-guides/api-integration/dapi-error-reference)            | Match returned API error identifiers to status, retry behaviour, and recovery.  |
| Reference | Look up smart contract error codes | [Smart contract error reference](/docs/developer-guides/api-integration/error-code-reference) | Decode contract revert codes returned through API error responses.              |

## Keep the navigation narrow [#keep-the-navigation-narrow]

Use this index for routing. Endpoint reference pages, generated OpenAPI pages, and workflow guides remain the source for implementation details. For mutation pages, check error handling and idempotency first. Review operational notes before production automation.
