HomeGuidesAPI Reference
API Reference

Create asset profile

post
https://example.com/profiles/asset

Creates a new profile for an asset identity

Body Params
string

unique identifier for the asset resource, will default to generated UUID if not provided

metadata
object

The asset metadata

string
deprecated

The asset configuration, in serialized JSON representation (deprecated, use metadata instead)

signatureTemplate
object

Override of the signature template used for this asset's signatures. Any field omitted falls back to the ledger-binding override and then to the router-config defaults.

verifiers
array of objects

A list of regulation verifiers to execute to validate a transaction

verifiers
intentTypes
array of objects

Allowed intent types to be applied on an asset

string
required
length ≤ 150

The name of the asset

string
length between 1 and 50

The symbol of the asset

string
enum
required
length ≤ 150

The type of the asset Payment asset classification:

  • Fiat: Government-issued currencies identified by ISO 4217 codes (e.g., USD, EUR, GBP)
  • Cryptocurrency: Blockchain-based digital currencies identified by appropriate crypto identifiers (e.g., BTC, ETH)
  • TokenizedCash: Blockchain-based digital cash maintaining 1:1 fiat peg (stablecoins, deposit tokens, CBDCs)
string
length ≤ 150

The Owner resource id

denomination
object
required
ledgerAssetBinding
object
required
assetPolicies
object
financialIdentifier
orgSettlementAccount
object
boolean
Defaults to true

Flag to indicate if default policy fallback is allowed when no matching policy is found

int32
0 to 18

Defines how many decimal places the asset supports. Used to determine the smallest divisible unit (e.g., cents for USD with 2 decimals, satoshis for BTC with 8 decimals).

boolean
Defaults to false

Flag to indicate if the asset should be automatically shared with known organizations.

Headers
string

32 bytes buffer (24 randomly generated bytes by the client + 8 bytes epoch timestamp seconds) encoded to hex:

const nonce = Buffer.alloc(32); nonce.fill(crypto.randomBytes(24), 0, 24);

const nowEpochSeconds = Math.floor(new Date().getTime() / 1000); const t = BigInt(nowEpochSeconds); nonce.writeBigInt64BE(t, 24);

Responses

Updated about 2 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago