Dictionary

Download Spec

Get combined dictionary

get /v1/{tenantName}/dictionary/combined

Get dictionary.

tenantName

string

required

The name of the tenant.

field[]

array[string]

required

string

Response

Examples Schema

Successful operation

{
  "blockchain_networks": [
    {
      "addresses": {
        "createCall": "string",
        "proxyAdmin": "string",
        "tokenFactory": "string",
        "tokenFactoryV2": "string"
      },
      "blockExplorerUrlOmitempty": "string",
      "confirmations": 123.0,
      "currencySymbol": "string",
      "gnosis": {
        "ownerOrDelegateSecretKey": "string",
        "safeTransactionBaseUrl": "string"
      },
      "networkId": 123.0,
      "networkName": "string"
    }
  ],
  "countries": [
    {
      "alpha2": "string",
      "alpha3": "string",
      "blocked": true,
      "name": {
        "common": "string",
        "official": "string"
      }
    }
  ],
  "currencies": [
    "string"
  ],
  "features": {
    "tokenManager": {
      "disabled": false
    }
  },
  "fees": [
    {
      "fees": {
        "buy": {
          "deposit": {
            "info_only": true,
            "percent": 123.0
          }
        },
        "providers": [
          {
            "methods": [
              {
                "fee": {
                  "info_only": true,
                  "percent": 123.0
                },
                "method": "string"
              }
            ],
            "payment_processor": "string"
          }
        ],
        "sell": {
          "deposit": {
            "info_only": true,
            "percent": 123.0
          }
        }
      },
      "markettype": "string"
    }
  ],
  "kyclevels": [
    {
      "active": true,
      "amlcheck": "string",
      "amlcheckrank": 123.0,
      "id": 123.0,
      "identitycheck": "string",
      "identitycheckrank": 123.0,
      "investortype": 123.0,
      "label": "string",
      "manualcheck": "string",
      "manualcheckrank": 123.0,
      "processors": [
        [
          123.0
        ]
      ],
      "riskid": 123.0,
      "upperlimit": 123.0
    }
  ],
  "payments": [
    {
      "methods": [
        "string"
      ],
      "processor": "string"
    }
  ],
  "preferred_countries": [
    "string"
  ],
  "project_legal_fields": [
    {
      "name": "string",
      "required": true
    }
  ],
  "token_lifecycle": {
    "initStates": 123.0,
    "isusueStates": [
      123.0
    ],
    "redeemStates": [
      123.0
    ],
    "transferStates": [
      123.0
    ],
    "transitions": {
      "1": [
        2,
        4,
        8
      ],
      "2": [
        4,
        8
      ],
      "4": [
        8
      ],
      "8": []
    }
  },
  "use_cases": [
    {
      "id": 123.0,
      "name": "string"
    }
  ]
}

causes:

  • schema not followed properly.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • authorization check failed.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

causes:

  • internal server error.
{
  "errors": [
    {
      "error_code": "validation_error",
      "message": "internal error",
      "name": "field_name"
    }
  ]
}

blockchain_networks

array[object]

object

addresses

object (addresses)

createCall

string

proxyAdmin

string

tokenFactory

string

tokenFactoryV2

string

blockExplorerUrlOmitempty

string

confirmations

number

currencySymbol

string

gnosis

object (gnosis)

ownerOrDelegateSecretKey

string

safeTransactionBaseUrl

string

networkId

number

networkName

string

countries

array[object]

object

alpha2

string

alpha3

string

blocked

boolean

name

object (name)

common

string

official

string

currencies

array[string]

string

features

object (features)

Available features

Example
{ "tokenManager": { "disabled": false } }

fees

array[object]

object

fees

object (fees)

buy

object (buy)

deposit

object (deposit)

info_only

boolean

percent

number

providers

array[object]

object

methods

array[object]

object

fee

object (fee)

info_only

boolean

percent

number

method

string

payment_processor

string

sell

object (sell)

deposit

object (deposit)

info_only

boolean

percent

number

markettype

string

kyclevels

array[object]

object

active

boolean

amlcheck

string

amlcheckrank

number

id

number

identitycheck

string

identitycheckrank

number

investortype

number

label

string

manualcheck

string

manualcheckrank

number

processors

array[array[number]]

array[number]

number

riskid

number

upperlimit

number

payments

array[object]

object

methods

array[string]

string

processor

string

preferred_countries

array[string]

string

project_legal_fields

array[object]

object

name

string

required

boolean

token_lifecycle

object (token_lifecycle)

initStates

number

isusueStates

array[number]

number

redeemStates

array[number]

number

transferStates

array[number]

number

transitions

object (transitions)

List of states.

Example
{ "1": [ 2, 4, 8 ], "2": [ 4, 8 ], "4": [ 8 ], "8": [] }

use_cases

array[object]

object

id

number

name

string

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

errors

array[object]

required

detailed error message

object

error_code

string

required

  • validation_error - Validation error
  • validation_required - Field value required
  • validation_min - Field value too small
  • validation_max - Field value too big
  • status_conflict - Entity already exists
  • status_bad_request - Invalid request
  • status_unauthorized - Unauthorized request
  • status_forbidden - Forbidden
  • status_not_found - Not found
  • status_internal_error - Internal error
Enum
  • validation_error
  • validation_required
  • validation_min
  • validation_max
  • status_conflict
  • status_bad_request
  • status_unauthorized
  • status_forbidden
  • status_not_found
  • status_internal_error

message

string

required

Example
"internal error"

name

string

Field name

Example
"field_name"

Was this page helpful?