Create Account

API

API Overview

This API allows you to create a new account to the system.

  • Request Method:POST

  • Request URL:https://openapi.elven.com/open/v3/entityAccount

Request Headers

Parameter NameTypeRequiredDescription

elven-api-key

String

Yes

The API key assigned to you

elven-api-sign

String

Yes

Request signature, used to verify the legitimacy of the request

elven-api-timestamp

String

Yes

Request timestamp, in milliseconds

View Details

Request Parameters

Body Parameters (JSON Format)

Parameter NameTypeRequiredDescription

name

String

Yes

The name of the account.

platformId

String

Yes

The platform identifier associated with the account.

identity

String

Yes

Account address or ID.

memo

String

No

Additional information or notes about the account.

auxiliaryValueList

Array

No

A list of auxiliary accounting fields,only supports Custom Options type.

auxiliaryValueList (array, optional)

Parameter NameTypeRequiredDescription

name

String

Yes

Auxiliary code name

value

String

Yes

“The corresponding value, which will be automatically created if it does not exist.

Example Request

{
    "name": "account1",
    "platformId": "zw1dbgFCXmZctjq06FbR4W3Gk8EBn2Iwz",
    "identity": "0xaaa",
    "memo": "this is memo",
    "auxiliaryValueList": [
        {
            "name": "counterparty",
            "value": "Counterparty1"
        },
        {
            "name": "text1",
            "value": "value1"
        }
    ]
}

Response Parameters

Parameter NameTypeDescription

entityAccountId

String

Account Primary Key

name

String

Account Name

platformId

String

PlatformId Primary Key

identity

String

Account Address

memo

String

memo

Example Response

{
    "entityAccountId": "xxxx",
    "name": "account1",
    "platformId": "xxx",
    "identity": "xxx",
    "memo": ""
}

Notes

  • The following headers are required for all requests to ensure security and validity: elven-api-key,elven-api-sign,elven-api-timestamp

  • The auxiliaryValueList only supports fields of the Custom Options type.

  • If the value for an auxiliary field does not exist, the system will automatically create it.

Last updated