/createTransactionPolicy

1 min

POST

Allows creating a transaction policy for MPC driven system.

Request Example:

.. code-block:: createTransactionPolicy( policy={ id="550e8400-e29b-41d4-a716-446655440000", name="My Transfer Policy", initiators={ "UserIds": [], "UserGroupIds": [], "All": true }, from={ "AccountIds": [1] }, to={ "Transfer": { "Destinations": { "ContactIds": [], "AddressGroupIds": [], "All": true }, "AllowSmartContractTransaction": true, "Ranges": [ { "RoleIdsToWorkflowIds": { "1": "3", "2": "3" } } ], "Frequency": 1, "AccountWallets": {} } }, assets={ "All": true, "Currencies": [] }, "RequestExtraData": { "MessageNumber": 2, "SessionId": "9a0a0176-abd3-4ee7-8194-681966cd75ca" } )

Response Example:

.. code-block::

{
    "FunctionData": {
            "StatusCode": 0,
            "StatusCodeDescription": "Policy created successfully"
    },
    "Meta": {
        "AccessToken": "2911...9a7",
        "Destination": "04bc...9e2",
        "Source": "3dcf...ba4",
        "Time": "2025-05-22 17:00:44.605"
    }
}

Error Responses

Error Type	Http Code	GK8 error code	Reason / Description	Example Response
Backend Response	400	1	Policy already exists	"StatusCode": 1
Backend Response	400	2	Policy name already exists	"StatusCode": 2
Backend Response	400	3	Invalid name	"StatusCode": 3
Backend Response	400	4	Unknown initiator	"StatusCode": 4, "Initiator": "[email protected]"
Backend Response	400	5	Invalid from	"StatusCode": 5
Backend Response	400	6	Invalid to	"StatusCode": 6
Backend Response	400	7	Duplicate initiator user	"StatusCode": 7, "UserId": "[email protected]"
Backend Response	400	8	Duplicate initiator user group	"StatusCode": 8, "UserGroupId": "123"
Backend Response	400	9	Empty Currencies in Assets but All is false	"StatusCode": 9
Backend Response	400	10	Non-empty Currencies in Assets but All is true	"StatusCode": 10
Backend Response	400	11	Empty Initiators but All is false	"StatusCode": 11
Backend Response	400	12	Non-empty Initiators but All is true	"StatusCode": 12
Backend Response	400	13	Duplicate account id	"StatusCode": 13, "AccountId": "1"
Backend Response	400	14	Duplicate contact	"StatusCode": 14, "ContactId": "1 "
Backend Response	400	15	Duplicate address group	"StatusCode": 15, "AddressGroupId": "123"
Backend Response	400	16	Unknown asset	"StatusCode": 16, "Asset": "ETH"
Backend Response	400	17	Duplicate asset	"StatusCode": 17, "Asset": "ETH"
Backend Response	400	18	Empty Destinations but All is false	"StatusCode": 18
Backend Response	400	19	Non-empty Destinations but All is true	"StatusCode": 19
Backend Response	400	20	Unknown frequency	"StatusCode": 20
Backend Response	400	21	Empty ranges	"StatusCode": 21
Backend Response	400	22	Invalid approval workflow in this policy	"StatusCode": 22, "ApprovalWorkflowId": "123"
Backend Response	400	23	Empty roles (DEPRECATED)	"StatusCode": 23
Backend Response	400	24	Unknown role	"StatusCode": 24, "RoleId": "0"
Backend Response	400	25	Unknown approval workflow	"StatusCode": 25, "ApprovalWorkflowId": "0"
Backend Response	400	26	Initiator lacks required account view permissions (UserIds deprecated)	"StatusCode": 26, "UserIds": ["[email protected]"]
Backend Response	400	27	Initiator group lacks account view permissions	"StatusCode": 27, "UserGroupIds": ["123"]
Backend Response	400	28	Unknown policy type	"StatusCode": 28
Backend Response	400	29	Policy settings overlap with existing configured policies	"StatusCode": 29, "PolicyName": "Policy 1"
Backend Response	400	30	Currency is unsupported for policy type	"StatusCode": 30, "Currency": "ETH"
Backend Response	400	31	Maximum amounts in Ranges are not in ascending order	"StatusCode": 31
Backend Response	400	32	Maximum is set to infinity but is not the last range	"StatusCode": 32
Backend Response	400	33	Role is unauthorized in a lower range	"StatusCode": 33, "RoleId": "123", "RangeIndex": 1
Backend Response	400	34	Unknown destination contact	"StatusCode": 34, "ContactId": "1 "
Backend Response	400	35	Unknown destination address group	"StatusCode": 35, "AddressGroupId": "1685892367498442087"
Backend Response	400	36	Mix of accounts selected with and without account change approvers	"StatusCode": 36, "AccountApproverAccountIds": [1,2], "NonAccountApproverAccountIds": [3,4]
Backend Response	400	37	Account change approver accounts have different approver settings	"StatusCode": 37
Backend Response	400	38	Policy involving account approvers cannot share an address group with other policies	"StatusCode": 38, "AddressGroupsIds": ["123"]
Backend Response	400	39	Range maximum is less than or equal to zero	"StatusCode": 39
Backend Response	400	40	Approval workflow lacks approvers with account view permissions	"StatusCode": 40
Backend Response	400	41	Empty sources	"StatusCode": 41, "AccountId": "1"
Backend Response	400	42	Unknown Wallet	"StatusCode": 42, "AccountId": "123", "WalletDerivationIndex": "0"
Backend Response	400	43	Omnibus account does not support specific sources info	"StatusCode": 43, "AccountId": "123"
Backend Response	400	44	Invalid smart contract limitations	"StatusCode": 44
Backend Response	400	45	Duplicate signature	"StatusCode": 45, "InvalidSignature": "func(int num)"
Backend Response	400	46	Address is not a contact	"StatusCode": 46, "Address": "0x1111111111111111111111111111111111111111"
Backend Response	400	47	Address is not a contract	"StatusCode": 47, "Address": "0x1111111111111111111111111111111111111111"
Backend Response	400	49	Invalid line	"StatusCode": 49, "InvalidInput": "number in (1,2,3)"
Backend Response	400	50	Invalid level	"StatusCode": 50, "InvalidInput": ">> burn(uint256 amount)"
Backend Response	400	51	Invalid address	"StatusCode": 51, "Address": "0x1111111111111111111111111111111111111111"
Backend Response	400	52	Invalid signature	"StatusCode": 52, "Signature": "number in (1,2,3)"
Backend Response	400	53	Invalid parameter type	"StatusCode": 53, "ParameterType": "uint256"
Backend Response	400	54	Invalid rule	"StatusCode": 54, "Rule": "number in (1,2,3)"
Backend Response	400	55	Smart contract limitation without all currencies	"StatusCode": 55
Backend Response	400	56	Staking supports only main addresses as From	"StatusCode": 56
Backend Response	400	57	Staking policy can be created for one coin only	"StatusCode": 57
Backend Response	400	58	Invalid staking withdrawal credentials type	"StatusCode": 58
Backend Response	400	59	ETH staking required withdrawal credentials	"StatusCode": 59
Backend Response	400	60	Invalid contact type	"StatusCode": 60, "ContactId": "1 "
Backend Response	400	61	Invalid address group type	"StatusCode": 61, "AddressGroupId": "123"

policyobject<p>TransactionPolicy (see MpcDriven/TransactionPolicy.py for examples on how to utilize this class)</p>

request_extra_dataobjectadditional data for the administrative request

acceptstringGenerated from available response content types

bodyobject

200success

curl --request POST \
     --url '/createTransactionPolicy?policy={%0A%22Id%22%3A%20%22550e8400-e29b-41d4-a716-446655440000%22%2C%0A%22Name%22%3A%20%22My%20Transfer%20Policy%22%2C%0A%22Initiators%22%3A%20{%0A%20%20%20%20%22UserIds%22%3A%20[]%2C%0A%20%20%20%20%22UserGroupIds%22%3A%20[]%2C%0A%20%20%20%20%22All%22%3A%20true%0A}%2C%0A%22From%22%3A%20{%0A%20%20%20%20%22AccountIds%22%3A%20[1]%0A}%2C%0A%22To%22%3A%20{%0A%20%20%20%20%22Transfer%22%3A%20{%0A%20%20%20%20%20%20%20%20%22Destinations%22%3A%20{%0A%20%20%20%20%20%20%20%20%20%20%20%20%22ContactIds%22%3A%20[]%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%22AddressGroupIds%22%3A%20[]%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%22All%22%3A%20true%0A%20%20%20%20%20%20%20%20}%2C%0A%20%20%20%20%20%20%20%20%22AllowSmartContractTransaction%22%3A%20true%2C%0A%20%20%20%20%20%20%20%20%22Ranges%22%3A%20[%0A%20%20%20%20%20%20%20%20%20%20%20%20{%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%22RoleIdsToWorkflowIds%22%3A%20{%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%221%22%3A%20%223%22%2C%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%222%22%3A%20%223%22%0A%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20}%0A%20%20%20%20%20%20%20%20%20%20%20%20}%0A%20%20%20%20%20%20%20%20]%2C%0A%20%20%20%20%20%20%20%20%22Frequency%22%3A%201%2C%0A%20%20%20%20%20%20%20%20%22AccountWallets%22%3A%20{}%0A%20%20%20%20}%0A}%2C%0A%22Assets%22%3A%20{%0A%20%20%20%20%22All%22%3A%20true%2C%0A%20%20%20%20%22Currencies%22%3A%20[]%0A}%0A&request_extra_data={%0A%20%20%22MessageNumber%22%3A%205%2C%0A%20%20%22SessionId%22%3A%20%223478593863424051983840947%22%0A}%0A' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "FunctionData": {
     "Id": "123",
     "Name": "policy name",
     "Initiators": {
     "All": "false"
     },
     "To": {
     "Transfer": {
     "AllowSmartContractTransactions": "true",
     "Destinations": {
     "All": "false"
     },
     "Ranges": [
     {
     "Maximum": 1000
     }
     ]
     }
     },
     "Assets": {
     "All": "false"
     },
     "RequestExtraData": {
     "MessageNumber": 5,
     "SessionId": "3478593863424051983840947"
     }
     },
     "Meta": {
     "FunctionName": "createTransactionPolicy",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'