{"_id":"5bc634877db17000250c43e0","project":"550f74bb6fc8130d0038aad3","version":{"_id":"550f75de61d9d30d00af9e01","__v":17,"project":"550f74bb6fc8130d0038aad3","forked_from":"550f74bb6fc8130d0038aad6","createdAt":"2015-03-23T02:09:34.221Z","releaseDate":"2015-03-23T02:09:34.221Z","categories":["550f75de61d9d30d00af9e02","551027e38579861900a86698","551029e08579861900a8669a","551029e7498062190006328a","5bc633a722d682005c9ad9e4","5bc633b08c4b0b000d6a7eaa","5bc633b48f3ff600626e3e18","5bc63538e5a6ba000d22ee6d","5bc63587a18a6b000decd295","5bc635c0937fcb0056223d9c","5bc6360f42f41800319aeaa6","5be5d13ff1d319002baca9ce","5be5d2287cd14d00291fbfdb","5be8b3b09f7cb70023c56a39","5be8b3cbb910100044e20206","5c1d769a4f6aed001fe527f0","5c402942010f0d001496dded"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"5bc633a722d682005c9ad9e4","project":"550f74bb6fc8130d0038aad3","version":"550f75de61d9d30d00af9e01","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2018-10-16T18:53:27.204Z","from_sync":false,"order":6,"slug":"accounts","title":"Accounts"},"user":"56ddd4424acab82000ae9d30","__v":14,"parentDoc":null,"updates":["5c68cb3266c99d00456c00cd"],"next":{"pages":[],"description":""},"createdAt":"2018-10-16T18:57:11.869Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"language":"json","code":"{\n\t\"type\":\"INDIVIDUAL\",\n\t\"country\": \"US\",\n  \"subaccount\": true,\n\t\"profileFields\":[\n\t\t{\n\t\t\t\"fieldId\": \"individualLegalName\",\n\t\t\t\"value\": \"Johnny Quest\"\n\t\t},\n\t\t{\n\t\t\t\"fieldId\": \"individualEmail\",\n\t\t\t\"value\": \"JohnnyQuest22:::at:::yolo.com\"\n\t\t},\n\t\t{\n\t\t\t\"fieldId\": \"individualResidenceAddress\",\n\t\t\t\"value\": {\n\t\t\t\t\"street1\": \"1 Market St\",\n\t\t\t\t\"street2\": \"Suite 402\",\n\t\t\t\t\"city\": \"San Francisco\",\n\t\t\t\t\"state\": \"CA\",\n\t\t\t\t\"postalCode\": \"94105\",\n\t\t\t\t\"country\": \"US\"\n\t\t\t}\n\t\t}\n\t]\n}"}]},"results":{"codes":[{"name":"","code":"{\n  \"id\" : \"AC-U4BWHGZDG6W\",\n  \"status\" : \"PENDING\",\n  \"type\" : \"INDIVIDUAL\",\n  \"country\" : \"US\",\n  \"createdAt\" : 1541789972000,\n  \"depositAddresses\" : {\n    \"ETH\" : \"0x98B031783d0efb1E65C4072C6576BaCa0736A912\",\n    \"BTC\" : \"14CriXWTRoJmQdBzdikw6tEmSuwxMozWWq\"\n  },\n  \"totalBalances\" : { \n    \"BTC\" : 1.0000000,\n    \"ETH\" : 0.1000000000000000000\n  },\n  \"availableBalances\" : { \n    \"BTC\" : 1.0000000,\n    \"ETH\" : 0.1000000000000000000\n  },\n  \"profileData\" : [ {\n    \"fieldId\" : \"individualCellphoneNumber\",\n    \"fieldType\" : \"CELLPHONE\",\n    \"value\" : null,\n    \"note\" : \"Must be verified by user.\",\n    \"status\" : \"OPEN\"\n  }, {\n    \"fieldId\" : \"individualEmail\",\n    \"fieldType\" : \"EMAIL\",\n    \"value\" : \"johnnyquest22@yolo.com\",\n    \"note\" : \"Must be verified by user.\",\n    \"status\" : \"OPEN\"\n  }, {\n    \"fieldId\" : \"individualLegalName\",\n    \"fieldType\" : \"STRING\",\n    \"value\" : \"Johnny Quest\",\n    \"note\" : null,\n    \"status\" : \"PENDING\"\n  }, {\n    \"fieldId\" : \"individualDateOfBirth\",\n    \"fieldType\" : \"DATE\",\n    \"value\" : null,\n    \"note\" : null,\n    \"status\" : \"OPEN\"\n  }, {\n    \"fieldId\" : \"individualSsn\",\n    \"fieldType\" : \"STRING\",\n    \"value\" : null,\n    \"note\" : null,\n    \"status\" : \"NULL\"\n  }, {\n    \"fieldId\" : \"individualResidenceAddress\",\n    \"fieldType\" : \"ADDRESS\",\n    \"value\" : {\n\t\t\t\t\"street1\": \"1 Market St\",\n\t\t\t\t\"street2\": \"Suite 402\",\n\t\t\t\t\"city\": \"San Francisco\",\n\t\t\t\t\"state\": \"CA\",\n\t\t\t\t\"postalCode\": \"94105\",\n\t\t\t\t\"country\": \"US\"\n\t\t},\n    \"note\" : null,\n    \"status\" : \"PENDING\"\n  }, {\n    \"fieldId\" : \"individualGovernmentId\",\n    \"fieldType\" : \"DOCUMENT\",\n    \"value\" : [],\n    \"note\" : null,\n    \"status\" : \"OPEN\"\n  }, {\n    \"fieldId\" : \"individualSourceOfFunds\",\n    \"fieldType\" : \"PAYMENT_METHOD\",\n    \"value\" : null,\n    \"note\" : \"Payment method not yet submitted\",\n    \"status\" : \"OPEN\"\n  } ]\n}","language":"json","status":200}]},"settings":"","apiSetting":"5c50b085aae6150014b3e80e","auth":"required","params":[{"_id":"5be6007145a5490061789903","ref":"","in":"body","required":true,"desc":"the type of account, currently `INDIVIDUAL` is the only supported value","default":"","type":"string","name":"type"},{"_id":"5be6007145a5490061789902","ref":"","in":"body","required":true,"desc":"the country of the account holder. For individuals this is the country of residence","default":"","type":"string","name":"country"},{"_id":"5be6007145a5490061789901","ref":"","in":"body","required":true,"desc":"an array of the Fields submitted at the time of Account creation. You can submit as many or as few fields as you need at the time of Account creation. [More information](doc:account-resource#section-fields)","default":"","type":"array_object","name":"profileFields"},{"_id":"5c400d555c006f0050b996c8","ref":"","in":"body","required":false,"desc":"Supply your own Account ID when creating noncustodial accounts","default":"","type":"string","name":"referrerAccountId"},{"_id":"5c400d555c006f0050b996c7","ref":"","in":"body","required":false,"desc":"when true, the newly created account will be a custodial subaccount owner by the caller. Otherwise, the account will be a standalone non-custodial account","default":"true","type":"string","name":"subaccount"}],"url":"/v3/accounts"},"isReference":true,"order":2,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Note on fields required\",\n  \"body\": \"When creating the account you can submit as many or as few profileFields as you need at the time of Account creation. [More information](doc:account-resource#section-fields)\"\n}\n[/block]","excerpt":"","slug":"create-account","type":"endpoint","title":"Create Account"}

postCreate Account


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

type:
required
string
the type of account, currently `INDIVIDUAL` is the only supported value
country:
required
string
the country of the account holder. For individuals this is the country of residence
profileFields:
required
array of objects
an array of the Fields submitted at the time of Account creation. You can submit as many or as few fields as you need at the time of Account creation. [More information](doc:account-resource#section-fields)
referrerAccountId:
string
Supply your own Account ID when creating noncustodial accounts
subaccount:
stringtrue
when true, the newly created account will be a custodial subaccount owner by the caller. Otherwise, the account will be a standalone non-custodial account

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Note on fields required", "body": "When creating the account you can submit as many or as few profileFields as you need at the time of Account creation. [More information](doc:account-resource#section-fields)" } [/block]