{"_id":"5be3c82b730652001a22cef4","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":10,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-11-08T05:22:51.500Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","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  \"profileFields\" : [ {\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:::at:::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\" : \"OPEN\"\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}","name":""},{"status":400,"language":"json","code":"{\n\t\n}","name":""}]},"examples":{"codes":[{"code":"'''\nThis is a Python 3.7 Module that gets a Wyre Account\ninformation using secret key authentication.\n\nYou can only use this module for getting individual\nor business accounts if you already have an account set up.\n\nIf you do not have a business or individual account with a secretKey/ApiKey,\ngo through the sign-up process for a test account here: https://www.testwyre.com/\n'''\nimport hashlib\nimport hmac\nimport json\nimport os\nimport requests\nimport time\nimport urllib.parse\n\n\nclass WyreApi:\n    ACCOUNT_ID = os.getenv(\"ACCOUNT_ID\")\n    API_KEY = os.getenv(\"WYRE_APIKEY\")\n    SEC_KEY = os.getenv(\"WYRE_TOKEN\")\n    API_VER3 = \"/v3\"\n    API_ACCOUNT_PATH = \"/accounts\"\n    API_URL = \"https://api.testwyre.com\"\n\n    '''\n        This method calculates the auth signature hash required for secret key \n        authentication\n    '''\n\n    def calc_auth_sig_hash(self, url_body):\n        # calculates a signature per Wyre API:\n        # https://docs.sendwyre.com/docs/authentication#secret-key-signature-auth\n        message, secret = bytes(\n            url_body, 'utf-8'), bytes(WyreApi.SEC_KEY, 'utf-8')\n        newhash = hmac.new(secret, message, hashlib.sha256)\n        return newhash.hexdigest()\n\n      \n      \n      \n      \n    '''\n        This method calculates a timesteamp required for the secret key \n        authentication\n    '''\n\n    def calcTimeStamp(self):\n        # creates a timestamp to the millisecond\n        return str(round(time.time() * 1000))\n      \n      \n      \n      \n    '''  \n     \t\tThis method gets account information and returns it as a json object\n        Prints an error message if call is unsuccessful.\n    '''\n    def getAccountInfo(self):\n        params = {\n            \"timestamp\": self.calcTimeStamp()\n            # If you are masquerading (acting on behalf) of your subaccount\n            # enter your account_id associated with your business account\n            # You could add that field in when passing data into the method\n            # \"masqueradeAs\": \"ENTER ACCOUNT ID HERE\"\n        }\n        url = WyreApi.API_URL + WyreApi.API_VER3 + WyreApi.API_ACCOUNT_PATH + \\\n            \"/\" + WyreApi.ACCOUNT_ID + \"?\" + \\\n            urllib.parse.urlencode(params, encoding='utf-8')\n\n        headers = {\n            'X-API-Key': WyreApi.API_KEY,\n            'X-API-Signature': self.calc_auth_sig_hash(url)\n        }\n        response = requests.get(url, headers=headers)\n        if response.status_code == 200:\n            return json.loads(response.text)\n        else:\n            print(response)\n\n\nif __name__ == \"__main__\":\n    #=========== Initializes a Wyre Obj ============= #\n    account = WyreApi()\n    response = account.getAccountInfo()\n    # response is the server response\n    if response:\n    \tprint(response)","language":"python"},{"language":"curl","code":"################### Get Wyre Account Information ###################\n# In this example below, I'm using the test env. When you are ready, use the production url: https://api.sendwyre.com\n\ncurl -X GET \\\n-H \"Authorization: Bearer SK-XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX\" \\\nhttps://api.testwyre.com/v3/accounts/:accountId\n#Ex: https://api.testwyre.com/v3/accounts/AC_XXXXXXXXXX"}]},"method":"get","apiSetting":"5c50b085aae6150014b3e80e","auth":"required","params":[{"_id":"5c3ffad2878531002c96d888","ref":"","in":"path","required":false,"desc":"The ID of the account you wish to retrieve","default":"","type":"string","name":"accountId"}],"url":"/v3/accounts/:accountId"},"isReference":true,"order":4,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"If you're requesting an account which is not your own because you're acting on behalf of the accountholder, you will need to use the [masqueradeAs](doc:authentication#masquerading) URL parameter. \\n\\nYou will encounter `AccessDeniedException` responses if you attempt to access a different account without this.\",\n  \"title\": \"Use Masquerading\"\n}\n[/block]","excerpt":"Retrieve all profile data for an account along with verification status","slug":"get-account","type":"endpoint","title":"Get Account"}

getGet Account

Retrieve all profile data for an account along with verification status

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

accountId:
string
The ID of the account you wish to retrieve

Examples


Result Format


Documentation

[block:callout] { "type": "warning", "body": "If you're requesting an account which is not your own because you're acting on behalf of the accountholder, you will need to use the [masqueradeAs](doc:authentication#masquerading) URL parameter. \n\nYou will encounter `AccessDeniedException` responses if you attempt to access a different account without this.", "title": "Use Masquerading" } [/block]