{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v3/users","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\n  \"id\" : \"US_UBWHGZDG6W\",\n  \"status\" : \"PENDING\",\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  \"fields\" : {\n    \"firstName\": {\n      \"value\": \"Charlie\",\n      \"status\": \"SUBMITTED\",\n      \"error\": null\n    },\n    \"lastName\": {\n      \"value\": \"Kelly\",\n      \"status\": \"SUBMITTED\",\n      \"error\": null\n    },\n    \"residenceAddress\": {\n      \"value\": {\n        \"street1\": \"1 Sunny St\",\n\t\t\t\t\"street2\": \"Suite 402\",\n\t\t\t\t\"city\": \"Philadelphia\",\n\t\t\t\t\"state\": \"PA\",\n\t\t\t\t\"postalCode\": \"55555\",\n\t\t\t\t\"country\": \"US\"\n      },\n      \"status\": \"SUBMITTED\",\n      \"error\": null\n    }\n  }\n}","language":"json","status":200}]},"params":[{"name":"blockchains","type":"array_string","default":"[]","desc":"List of blockchains to connect the user to. Supported: `BTC`, `ETH`, `ALL`. Defaults to none (empty list).","required":false,"in":"body","ref":"","_id":"5fd93001cade03004e8f940d"},{"name":"immediate","type":"boolean","default":"false","desc":"If true, returns immediately. This skips the default behavior of waiting up to 5 seconds for processing to complete, and so will always result in a PENDING user.","required":false,"in":"body","ref":"","_id":"5fd93001cade03004e8f940c"},{"name":"fields","type":"object","default":"","desc":"Maps field IDs to their respective values","required":false,"in":"body","ref":"","_id":"5fd93001cade03004e8f940b"},{"name":"scopes","type":"array_string","default":"","desc":"Array of scopes to bias the view returned after the user is created. Only valid scope is currently `TRANSFER`","required":false,"in":"body","ref":"","_id":"5fd93001cade03004e8f940a"}],"examples":{"codes":[{"code":"{\n  \"fields\": {\n    \"firstName\": \"Deandre\",\n    \"lastName\": \"Renoylds\",\n    \"residenceAddress\": {\n      \"street1\": \"1 Sunny Dr\",\n      \"street2\": null,\n      \"city\": \"Philadelphia\",\n      \"state\": \"PA\",\n      \"postalCode\": \"55555\",\n      \"country\": \"US\"\n    }\n  },\n  \"blockchains\":[\"ALL\"],\n  \"immediate\": false,\n  \"scopes\":[\"TRANSFER\"]\n}","language":"json"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"Create User","type":"endpoint","slug":"create-user","excerpt":"","body":"This endpoint creates a new container for personal data on behalf of one of your customers: a user.\n\nThe field IDs returned are controlled by the `scopes` provided. All identified fields returned on the object reflect fields which are presently required to achieve access to the requested scopes.\n\nUnlike the rest of the user APIs, this endpoint does not require masqerading.","updates":[],"order":1,"isReference":false,"hidden":true,"sync_unique":"","link_url":"","link_external":false,"_id":"5fd92cba360b010024831f1d","createdAt":"2020-12-15T21:38:02.687Z","user":"5f7f6ea298ba660011771f74","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Users","slug":"users","order":9,"from_sync":false,"reference":false,"_id":"5fd92bf362bb7301b00e48ba","createdAt":"2020-12-15T21:34:43.197Z","version":"550f75de61d9d30d00af9e01","project":"550f74bb6fc8130d0038aad3","__v":0},"version":{"version":"3","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["550f75de61d9d30d00af9e02","551027e38579861900a86698","551029e08579861900a8669a","551029e7498062190006328a","5bc633a722d682005c9ad9e4","5bc633b08c4b0b000d6a7eaa","5bc633b48f3ff600626e3e18","5bc63538e5a6ba000d22ee6d","5bc63587a18a6b000decd295","5bc635c0937fcb0056223d9c","5bc6360f42f41800319aeaa6","5be5d13ff1d319002baca9ce","5be5d2287cd14d00291fbfdb","5be8b3b09f7cb70023c56a39","5be8b3cbb910100044e20206","5c1d769a4f6aed001fe527f0","5c402942010f0d001496dded","5e8127d61c906800374eeb1c","5f2768c98622b8005106544a","5f2768d05702ca0011f7655e","5f276e5348d2b600321aef9b","5f276fd300e519001139200a","5f9a2cb79dafe500259281a7","5fd92bf362bb7301b00e48ba"],"_id":"550f75de61d9d30d00af9e01","__v":24,"releaseDate":"2015-03-23T02:09:34.221Z","project":"550f74bb6fc8130d0038aad3","createdAt":"2015-03-23T02:09:34.221Z","forked_from":"550f74bb6fc8130d0038aad6"},"project":"550f74bb6fc8130d0038aad3","__v":12,"parentDoc":null}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

blockchains:
array of strings[]
List of blockchains to connect the user to. Supported: `BTC`, `ETH`, `ALL`. Defaults to none (empty list).
immediate:
booleanfalse
If true, returns immediately. This skips the default behavior of waiting up to 5 seconds for processing to complete, and so will always result in a PENDING user.
fields:
object
Maps field IDs to their respective values
scopes:
array of strings
Array of scopes to bias the view returned after the user is created. Only valid scope is currently `TRANSFER`

Examples


Result Format


Documentation

This endpoint creates a new container for personal data on behalf of one of your customers: a user. The field IDs returned are controlled by the `scopes` provided. All identified fields returned on the object reflect fields which are presently required to achieve access to the requested scopes. Unlike the rest of the user APIs, this endpoint does not require masqerading.