Assets
Authorizations
X-API-KEYstringRequired
Query parameters
pagenumber · nullableOptionalDefault:
1limitnumber · nullableOptionalDefault:
10includestringOptionalExample:
account, offering, bonusTiersnamestringOptional
accountIdstringOptionalExample:
account_01j1xgme5qeqq97gpdztd7e4a6offeringIdanyOptionalExample:
offering_01jayn2qkpeebav9gjpqx7xm8jissuerIdanyOptional
typestring · enumOptionalPossible values:
Responses
200
200
application/json
400
400
application/json
401
401
application/json
403
403
application/json
get
/clients/api/v1/assetsAuthorizations
X-API-KEYstringRequired
Body
offeringIdanyRequiredExample:
offering_01jayn2qkpeebav9gjpqx7xm8jnamestring · min: 2 · max: 50RequiredExample:
Asset nametypestring · enumRequiredExample:
STOCKPossible values: pricePerUnitnumber · min: 0.01 · max: 10000000000 · nullableRequiredExample:
2000totalUnitsnumber · min: 1 · max: 10000000000 · nullableRequiredExample:
5200yieldnumber · min: 0.01 · max: 10000000000 · nullableOptionalExample:
1200durationnumber · min: 1 · max: 1000 · nullableOptionalExample:
1durationTypestring · enum · nullableOptionalExample:
DAYSPossible values: templatestring · enumOptionalDefault:
STANDARDExample: STANDARDPossible values: tiersnumber[] · nullableOptional
enableBonusbooleanOptionalDefault:
falseExample: falseinterestRatenumber · min: 0.01 · max: 100 · nullableOptionalExample:
10Responses
201
201
application/json
401
401
application/json
403
403
application/json
409
409
application/json
500
500
application/json
post
/clients/api/v1/assetsAuthorizations
X-API-KEYstringRequired
Path parameters
idstringRequiredExample:
asset_00041061050r3gg28a1c60t3gfQuery parameters
includestringOptionalExample:
account, offering, bonusTiersResponses
200
200
application/json
idstringRequiredExample:
asset_00041061050r3gg28a1c60t3gf__entitystringOptionalExample:
EntitycreatedAtone ofRequiredExample:
2026-03-27T15:47:09.539Zstring · date-timeOptional
string · date-timeOptional
updatedAtone ofRequiredExample:
2026-03-27T15:47:09.539Zstring · date-timeOptional
string · date-timeOptional
deletedAtone of · nullableRequiredExample:
2026-03-27T15:47:09.540Zstring · date-timeOptional
string · date-timeOptional
namestringRequired
typestring · enum · nullableRequiredPossible values:
pricePerUnitnumber · nullableRequired
totalUnitsnumber · nullableRequired
totalAmountnumber · nullableRequired
yieldnumber · nullableRequired
durationnumber · nullableRequired
durationTypestring · enum · nullableRequiredPossible values:
accountIdstringRequired
offeringIdstringRequired
offeringany · nullableOptional
templatestring · enumRequiredPossible values:
tiersnumber[] · nullableRequired
enableBonusbooleanRequired
interestRatenumber · nullableRequired
400
400
application/json
401
401
application/json
403
403
application/json
404
404
application/json
get
/clients/api/v1/assets/{id}Authorizations
X-API-KEYstringRequired
Path parameters
idstringRequiredExample:
asset_00041061050r3gg28a1c60t3gfBody
namestring · min: 2 · max: 50OptionalExample:
Ztypestring · enumOptionalExample:
STOCKPossible values: pricePerUnitnumber · min: 0.01 · max: 10000000000 · nullableOptionalExample:
2000totalUnitsnumber · min: 1 · max: 10000000000 · nullableOptionalExample:
5200yieldnumber · min: 0.01 · max: 10000000000 · nullableOptionalExample:
1200durationnumber · min: 1 · max: 1000 · nullableOptionalExample:
1durationTypestring · enum · nullableOptionalExample:
DAYSPossible values: templatestring · enum · nullableOptionalDefault:
STANDARDExample: STANDARDPossible values: tiersnumber[] · nullableOptional
enableBonusbooleanOptionalExample:
falseinterestRatenumber · min: 0.01 · max: 100 · nullableOptionalExample:
10Responses
201
201
application/json
400
400
application/json
401
401
application/json
403
403
application/json
404
404
application/json
500
500
application/json
put
/clients/api/v1/assets/{id}Last updated