Sign in
Asset Profiles

Update asset profile

Updates an asset profile. At least one field must be provided. The resulting category/type pair must be supported. Public metadata is recomputed when metadata or the asset type changes; set issuanceMetadata.visibility.public to control which fields are exposed (asset.* and chain.decimals only).

patch/v1/issuance/asset-profiles/{profileId}

Path parameters

profileIdstring required

Asset profile identifier.

Example:asset_profile_example

Asset profile identifier.

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Request body

assetCategory'generic' | 'stablecoin' | 'tokenized_security'

Updated asset category. Must remain consistent with the asset type.

assetTypestring

Updated asset type. Must be supported for the (resulting) category.

Example request

{
  "assetCategory": "stablecoin",
  "assetType": "fiat_backed",
  "issuanceMetadata": {
    "asset": {
      "name": "Acme USD",
      "issuerName": "Acme Financial Inc.",
      "pegCurrency": "USD",
      "website": "https://acme.example"
    },
    "compliance": {
      "transferRestrictions": "reg_d"
    },
    "chain": {
      "decimals": 6
    },
    "custom": {
      "customer": {
        "internalDeskId": "FX-22"
      },
      "integration": {}
    },
    "visibility": {
      "public": [
        "asset.name",
        "asset.issuerName",
        "asset.pegCurrency",
        "chain.decimals"
      ]
    },
    "settings": {
      "version": 1,
      "selected": {
        "pauseTransfers": {},
        "freezeAccounts": {},
        "transferFee": {
          "params": {
            "basisPoints": 50,
            "maxFee": "100"
          }
        }
      }
    }
  }
}

Response

Asset profile updated

Example response

{
  "data": {
    "assetProfile": {
      "id": "asset_profile_example",
      "organizationId": "org_example",
      "projectId": "prj_example",
      "tokenId": "tok_example",
      "assetCategory": "stablecoin",
      "assetType": "fiat_backed",
      "assetTypeVersion": 2,
      "issuanceMetadata": {
        "asset": {
          "name": "Acme USD",
          "issuerName": "Acme Financial Inc.",
          "pegCurrency": "USD",
          "website": "https://acme.example"
        },
        "compliance": {
          "transferRestrictions": "reg_d"
        },
        "chain": {
          "decimals": 6
        },
        "custom": {
          "customer": {
            "internalDeskId": "FX-22"
          },
          "integration": {}
        },
        "visibility": {
          "public": [
            "asset.name",
            "asset.issuerName",
            "asset.pegCurrency",
            "chain.decimals"
          ]
        },
        "settings": {
          "version": 1,
          "selected": {
            "pauseTransfers": {},
            "freezeAccounts": {},
            "transferFee": {
              "params": {
                "basisPoints": 50,
                "maxFee": "100"
              }
            }
          }
        }
      },
      "publicMetadata": {
        "asset": {
          "name": "Acme USD",
          "issuerName": "Acme Financial Inc.",
          "pegCurrency": "USD"
        },
        "chain": {
          "decimals": 6
        }
      },
      "status": "active",
      "createdBy": "usr_example",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-02T00:00:00.000Z"
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}

Changes

Changed in 1 of the 10 revisions of this API.5

  • 3e302bba53865See the full diff
    • ●

      added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 401

      response-property-enum-value-added

    • ●

      added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new SERVICE_UNAVAILABLE enum value to the error/code response property for the response status 500

      response-property-enum-value-added