Skip to main content

Create an Account

POST 

/v2/accounts

With the account creation endpoint, you have the ability to create parent accounts and subaccounts.

Request

Body

    data object required
    oneOf
    type stringrequired

    Default value: account

    Specifies the the type of object. Set this value to account.

    name stringrequired

    Specifies the name of the account.

    legal_name stringrequired

    Specifies the legal name of the account.

    registration_id string

    Specifies the registration ID. If specified, this field is checked for uniqueness.

    external_ref string

    The unique attribute associated with the account. For example, this could be an external reference from a separate company system. The maximum length is 2048 characters. Default is null.

Responses

Created

Schema
    data object
    type stringrequired

    Default value: account

    Specifies the the type of object. Set this value to account.

    name stringrequired

    Specifies the name of the account.

    legal_name stringrequired

    Specifies the legal name of the account.

    registration_id string

    Specifies the registration ID. If specified, this field is checked for uniqueness.

    external_ref string

    The unique attribute associated with the account. For example, this could be an external reference from a separate company system. The maximum length is 2048 characters. Default is null.

    id UUID (string)

    The unique identifier for an Account.

    meta object

    Additional information for this realm. For more information, see The meta object section.

    timestamps object
    created_at string

    The date the account is created.

    updated_at string

    The date the account is updated.

    links object
    self string

    A URL to the specific resource.

Loading...