Create a New User Account

post https://apex-crypto/api/v2/accounts

Use this endpoint to create new investor accounts. The client must provide an account ID that uniquely identifies the investor from other investors on the client's platform.

Responses

Response body

object

cipClearanceState

string

PENDING - The CIP check is waiting to be processed
IN_PROGRESS - The CIP check is being processed
ACCEPTED - The CIP check result was good
INDETERMINATE - The CIP check result was indeterminate. Customer should review and update their account information
REJECTED - The CIP check result was rejected. Customer should review and update their account information
FAILED - The CIP check could not be processed. Please contact us to resolve this issue

PENDING IN_PROGRESS ACCEPTED INDETERMINATE REJECTED FAILED

createdAt

date-time

required

The time the account was created

string

required

Bakkt unique internal account identifier

mode

string

required

The mode that the account is in

OPEN CLOSED LOCKED CLOSING_ONLY

pendingUpdateIds

array of strings

The ID of any pending updates requested for the account

pendingUpdateIds

request

object

required

accountType

string

Customer account type

INDIVIDUAL CUSTODIAL ENTITY_PERSONAL_TRUST ENTITY

clientAccountId

string

required

Client-specified unique identifier for the account (clientAccountId)

enrollments

object

DEPRECATED.

entity

object

Entity details

string

DEPRECATED. Please use clientAccountId

investmentProfile

object

owners

array of objects

required

≥ 1

owners*

object

agreements

array of objects

required

agreements*

object

eSignedDate

date-time

Date of electronic signature of the agreement

name

string

required

Name of the agreement document

text

string

Text containing the body of the agreement document

version

string

required

Agreement document version

clientOwnerId

string

Client provided unique owner id (required when multiple owners are present or national id is specified)

emailAddress

string

required

Customer's contact email

identity

object

required

identityId

string

DEPRECATED.

mailingAddress

object

required

ownerId

string

Bakkt owner identifier

phoneNumber

string

Customer's contact phone number (Should be in compacted E.164 format, eg UK (+44) 1234 123456 becomes +441234123456)

role

string

required

AUTHORIZED_AGENT AUTHORIZED_MEMBER AUTHORIZED_OWNER BENEFICIAL_OWNER BENEFICIARY CUSTODIAN EDUCATION_BENEFICIARY EDUCATION_MANAGER EXECUTOR GUARDIAN_CONSERVATOR INTERNAL_POWER_OF_ATTY INITIAL_DEPOSITOR JOINT_OWNER MINOR_OWNER PRIMARY_OWNER POWER_OF_ATTY SOLE_PROPRIETOR TRADING_AUTHORITY TREASURER TRUSTEE TRUSTED_CONTACT

settlementMethod

string

Method of settlement for the customer account

BAKKT_TPJ NET_SETTLEMENT

trustedContacts

array of objects

trustedContacts

object

emailAddress

string

The trusted contact's email address

familyName

string

required

The trusted contact's family (typically last) name

givenName

string

required

The trusted contact's given (typically first) name

mailingAddress

object

middleNames

string

The trusted contact's middle name(s). Space or comma separated.

phoneNumber

string

The trusted contact's phone number

status

string

required

Status of a request, where the request is a long running operation

PENDING ACCEPTED IN_PROGRESS REJECTED CANCELLED COMPLETE

Language

Credentials

Header


xxxxxxxxxx
19
1
curl --request POST \
2
     --url https://apex-crypto/api/v2/accounts \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "entity": {
8
    "entityType": "CORPORATE"
9
  },
10
  "investmentProfile": {
11
    "accountGoals": {
12
      "investmentObjective": "BALANCED"
13
    },
14
    "customerProfile": {
15
      "annualIncomeRangeUsd": "UNDER_25K"
16
    }
17
  }
18
}
19
'

Choose an example:

application/json

200This response returns the newly created account for this investor.

422This response returns a validation failure with additional details about specific sections of the request that failed validation in both machine-readable and developer-friendly messages tied to fields by name.

defaultThis response returns if the system encounters an unexpected error while handling this request.