Compliance templates
Create, list, search, filter, publish, and delete reusable compliance templates through the DALP API.
A compliance template is a reusable policy pattern that an integration prepares before operators create assets. Each template stores its modules, jurisdictions, required controls, draft or published status, and module-set version.
Use these endpoints when your integration prepares policy templates before operators create assets in the Asset Designer. For the system-level module registry that templates rely on, see Compliance modules API. For the operator workflow, see Policy templates.
Template state model
Compliance templates can be DALP library templates or organisation templates. List responses include both by default. DALP library templates sort before organisation templates and are immutable through the organisation API: integrations can read and filter them, but cannot update, publish, or delete them.
Organisation templates start as drafts. Drafts can be edited, then published when ready for asset creation workflows. Publishing changes isDraft to false. A repeat publish request returns a conflict response instead of creating a new version.
Jurisdictions are stored on the template. A template with no jurisdictions is a global template. When you filter for a specific jurisdiction, the API returns templates tagged with that jurisdiction and global templates, so an integration can show global defaults beside jurisdiction-specific options.
Endpoints
The compliance template API exposes these endpoints:
| Endpoint | Use it for |
|---|---|
GET /api/v2/settings/compliance-templates | List compliance templates in the active tenant. |
POST /api/v2/settings/compliance-templates | Create a draft compliance template. |
GET /api/v2/settings/compliance-templates/{id} | Read one compliance template. |
PUT /api/v2/settings/compliance-templates/{id} | Update a compliance template. |
PUT /api/v2/settings/compliance-templates/{id}/publish | Publish a draft template for asset creation. |
DELETE /api/v2/settings/compliance-templates/{id} | Delete a compliance template. |
Responses use the DALP single-resource or collection envelope with data and links.self. List responses also include pagination metadata. Facets are returned for isSystem, isDraft, and moduleSetVersion.
Create a draft template
Create requests start a template in draft state. If you omit moduleSetVersion, DALP uses the current compliance module generation. Older clients may still send the deprecated legacy boolean; new integrations should send moduleSetVersion instead.
Current-generation control IDs
Use moduleSetVersion: 2 for new templates. DALP validates every modules[].typeId and every requiredControls[] entry against that generation before it saves or publishes the template. On create requests, incompatible values are schema validation errors on the offending field paths, such as modules.0.typeId or requiredControls.0. The same compatibility rules apply whether the control is already configured in modules or only required for the later asset-creation workflow.
| Control type ID | Category | Use it when the template should require |
|---|---|---|
address-block-list-v2 | Identity | Blocked wallet addresses. |
capital-raise-limit | Limits | A fiat-denominated capital raise window and cap. |
capped-v2 | Limits | A maximum token supply in raw token units. |
collateral-v2 | Collateral | Collateral proof claims and a configured collateral ratio. |
country-allow-list-v2 | Geographic | Recipient countries limited to allowed ISO 3166-1 numeric codes. |
country-block-list-v2 | Geographic | Recipient countries not on the selected ISO 3166-1 numeric block list. |
identity-allow-list-v2 | Identity | Recipient identities limited to the allowed on-chain identity list. |
identity-block-list-v2 | Identity | Recipient identities not on the selected on-chain identity block list. |
identity-verification-v2 | Identity | A claim expression, such as KYC or investor eligibility claims. |
investor-count-v2 | Limits | A maximum number of investors for the module instance. |
time-lock-v2 | Transfer | A minimum holding period before transfers can leave the holder. |
transfer-approval-v2 | Transfer | Transfer approvals from configured approval authorities. |
Legacy templates with moduleSetVersion: 1 can still use the older control IDs when an integration reads or maintains an existing policy set. Do not mix legacy IDs such as country-allow-list, investor-count, or transfer-approval into a current-generation template. On create, the API rejects the incompatible field during request validation. On update or publish, the API can return the module-set compatibility error with the incompatible type IDs.
curl --request POST \
"$DALP_API_URL/api/v2/settings/compliance-templates" \
--header "X-Api-Key: $DALP_API_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"name": "Global capital raise policy",
"description": "Reusable capital raise controls for regulated assets",
"jurisdictions": [],
"moduleSetVersion": 2,
"modules": [],
"requiredControls": ["capital-raise-limit"]
}'The response includes the created template and a links.self path for the new resource.
Update template configuration
Update requests can change the name, description, jurisdictions, modules, and required controls. Update requests cannot change the template's module generation. If an integration needs a different generation, create a new template with the target moduleSetVersion and move the required modules or controls there.
DALP validates modules and required controls against the template generation on create, update, and publish. On create, an incompatible control is a request validation error on the field that supplied it. On update or publish, a current-generation template cannot save controls that only belong to a legacy module set. If the API returns a module-set compatibility error, remove the incompatible controls or create a template with the matching generation.
Publish a template
Publish the template when it is ready to appear in asset creation workflows:
curl --request PUT \
"$DALP_API_URL/api/v2/settings/compliance-templates/$TEMPLATE_ID/publish" \
--header "X-Api-Key: $DALP_API_TOKEN"Publishing changes isDraft to false. Published templates can be selected during asset creation. Draft templates remain editable preparation records.
List and filter templates
Use the list endpoint to find templates by search, draft status, source, jurisdiction, or module generation. By default, the list includes DALP library templates and templates owned by the active organisation, with DALP library templates sorted first.
The list endpoint uses the standard collection query pattern:
| Query control | Use it for |
|---|---|
filter[q] | Search across template text fields. |
sort | Sort the collection. The default sort is name; use a leading minus sign for descending order, such as sort=-updatedAt. |
page[limit] and page[offset] | Page through large template libraries. |
filter[...] | Restrict the collection to templates that match a field value. |
Supported filter and sort fields:
| Field | Type | Use it for |
|---|---|---|
name | Text | Filter, search, or sort by template name. |
jurisdiction | Text | Return templates for a jurisdiction. GLOBAL returns templates with no specific jurisdiction. |
isDraft | Boolean | Return draft templates with true, or published templates and DALP library templates with false. |
moduleSetVersion | Number | Return templates for one compliance module generation. |
isSystem | Boolean | Return only DALP library templates with true, or only organisation templates with false. |
createdAt | Date | Filter or sort by creation time. |
updatedAt | Date | Filter or sort by last update time. |
For example, request recently updated current-generation draft templates when your integration is preparing a new organisation policy set:
curl --globoff \
"$DALP_API_URL/api/v2/settings/compliance-templates?filter[moduleSetVersion]=2&filter[isDraft]=true&filter[isSystem]=false&sort=-updatedAt&page[limit]=25" \
--header "X-Api-Key: $DALP_API_TOKEN"The response contains a data array of compliance templates. Each template includes id, name, description, jurisdictions, isSystem, isDraft, moduleSetVersion, organizationId, version, modules, requiredControls, createdBy, createdAt, and updatedAt. Collection metadata lets clients render paginated tables. Facets for isSystem, isDraft, and moduleSetVersion let clients build source, status, and module-generation filters without hard-coding the available values.
Read the template before you update it. Another operator or integration may have changed the template version or draft status since your last read.