Skip to main content
POST
/
v3
/
api
/
servicedesk
/
products
Retrieve products and services
curl --request POST \
  --url https://api.custody.api-zodia.io/v3/api/servicedesk/products \
  --header 'Content-Type: application/json' \
  --header 'X-Signature: <api-key>' \
  --header 'submitter-id: <submitter-id>' \
  --data '
{
  "products": [
    "CUSTODY"
  ],
  "productIds": [
    "0x0013"
  ],
  "serviceIds": [
    "0x0013-001"
  ],
  "serviceNames": [
    "Custody Wallet Management"
  ],
  "requestTypes": [
    "CREATE"
  ]
}
'
{
  "items": [
    {
      "product": "CUSTODY",
      "productId": 19,
      "serviceId": "0x0013-001",
      "serviceName": "Custody Wallet Management",
      "requestType": "CREATE",
      "description": "Custody Wallet",
      "template": {
        "name": [
          "MY_Wallet"
        ],
        "currency": [
          "ETH | BTC"
        ],
        "currencyId": [
          "eth-Seth | btc-btc"
        ],
        "walletOwnerId": [
          "Wallet_Beneficiary_ID"
        ]
      }
    }
  ]
}

Authorizations

​
X-Signature
string
header
required

Headers

​
submitter-id
string
required

Email of API user submitting the request

Example:

"api-maker@zodia.io"

Body

application/json

Payload for filtering product catalog

​
products
string[]

Search by product offering i.e. NETWORK_MGMT, TRADING, CUSTODY

​
productIds
string[]

Search by product IDs

​
serviceIds
string[]

Search by service IDs

​
serviceNames
string[]

Search by service names. Note the search text needs to match the given service names

​
requestTypes
string[]

Search by request type i.e. CREATE, UPDATE or DEACTIVATE

Response

OK

​
items
object[]

Each serviceName, requestType and description combined uniquely identifies an operation on the platform. For the sample response on the right the serviceId 0x0013-001 allows the creation of a custody wallet