/createContacts

1 min

POST

/createContacts

This API allows creating contacts from the MPC.

Request Example:

.. code-block:: createContacts( contacts=[ { Name="contact1", Currency="ETH", Address="0xbebd0bdD4820Cb0ddc2E83b68A5C68DFbA093fe6", AddressGroupIds=["123"], AuthorizationType=1, ContactType=3 }, { Name="contact2", Currency="XTZ", Address="tz1fPL4Ssv2US4DpYbrBgSvRYuZqzVUXxpyk", AddressGroupIds=["123"], AuthorizationType=2, ContactType=5 } ], request_extra_data={ "MessageNumber": 5, "SessionId": "3478593863424051983840947" } )

Response Example:

.. code-block::

{
    "FunctionData": {
            "ContactIds": [
                        "1:0xdAC17F958D2ee523a2206206994597C13D831ec7",
                        "1:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
                    ],
            "StatusCode": 0,
            "StatusCodeDescription": "Contacts 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	200	0	Contacts created successfully	"StatusCode": 0, "ContactIds": ["1 ", "1002 "]
Backend Response	400	1	Contact already exists (also returned for Cold wallet contact)	"StatusCode": 1, "Currency": "ETH", "Address": "0xbebd0bdD4820Cb0ddc2E83b68A5C68DFbA093fe6"
Backend Response	400	2	Invalid name	"StatusCode": 2, "Currency": "ETH", "Address": "0xbebd0bdD4820Cb0ddc2E83b68A5C68DFbA093fe6"
Backend Response	400	3	Unknown address group	"StatusCode": 3, "AddressGroupIds": ["123"], "Currency": "ETH", "Address": "0xbebd0bdD4820Cb0ddc2E83b68A5C68DFbA093fe6"
Backend Response	400	4	Unknown currency	"StatusCode": 4, "Currency": "ETH"
Backend Response	400	5	Unknown authorization type	"StatusCode": 5, "AuthorizationType": 8, "Currency": "ETH", "Address": "0xbebd0bdD4820Cb0ddc2E83b68A5C68DFbA093fe6"
Backend Response	400	6	Invalid address	"StatusCode": 6, "Currency": "ETH", "Address": "0xbebd0bdD4820Cb0ddc2E83b68A5C68DFbA093"
Backend Response	400	7	Duplicate contact	"StatusCode": 7, "Currency": "ETH", "Address": "0xbebd0bdD4820Cb0ddc2E83b68A5C68DFbA093"
Backend Response	400	8	At most one address group per contact is supported (DEPRECATED in V13)	"StatusCode": 8
Backend Response	400	9	Node is currently unavailable	"StatusCode": 9
Backend Response	400	10	Smart contract contacts cannot be authorized as internal addresses	"StatusCode": 10, "Currency": "ETH", "Address": "0xbebd0bdD4820Cb0ddc2E83b68A5C68DFbA093"
Backend Response	400	11	Too many contacts in request	"StatusCode": 11, "Limit": 1000
Backend Response	400	12	Inactive currency	"StatusCode": 12, "Currency": "BCH"
Backend Response	400	13	Unknown contact type	"StatusCode": 13, "ContactType": 1, "Currency": "ETH", "Address": "0xbebd0bdD4820Cb0ddc2E83b68A5C68DFbA093fe6"
Backend Response	400	14	Invalid currency for validator contact	"StatusCode": 14, "Currency": "ETH"
Backend Response	400	15	Adding contact to address group leads to overlapping settings in two policies	"StatusCode": 15, "AddressGroupId": "3", "PolicyIds": ["123", "456"]
Backend Response	400	16	Address group does not match contact type	"StatusCode": 16, "AddressGroupId": "3"
Backend Response	400	17	Empty contact list	"StatusCode": 17

contactsarray<p>a list of 'Contact' objects (Contact class is defined in apiclient/MpcDriven/Contact.py). Duplicate contacts with identical currency symbols and addresses cannot be added.</p>

request_extra_dataobjectadditional data for the administrative request

acceptstringGenerated from available response content types

bodyobject

200success

curl --request POST \
     --url '/createContacts?contacts=array&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": {
     "Contacts": [
     {
     "Name": "contact name",
     "Currency": "ETH",
     "Address": "0x123",
     "AuthorizationType": 1
     }
     ],
     "RequestExtraData": {
     "MessageNumber": 5,
     "SessionId": "3478593863424051983840947"
     }
     },
     "Meta": {
     "FunctionName": "createContacts",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'