{"__v":1,"_id":"569923123da4370d009d20c9","category":{"__v":7,"_id":"56914e9bd47b020d002225ac","pages":["5691500e3c4f510d00ec9baa","5691543972f2810d007e4cc1","5692a6d74c4d6d0d00f7cb4b","5694070ebcd0a90d0044d2a6","56952386fcb1032d0089df94","5695238fcaa32519009c4114","569923123da4370d009d20c9"],"project":"563cc7119799fb0d00047685","version":"563cc7119799fb0d00047688","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-09T18:16:59.760Z","from_sync":false,"order":1,"slug":"rest-api","title":"Accounts"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"563cc7119799fb0d00047685","user":"56957802fe18811700c9c07e","version":{"__v":16,"_id":"563cc7119799fb0d00047688","project":"563cc7119799fb0d00047685","createdAt":"2015-11-06T15:28:17.683Z","releaseDate":"2015-11-06T15:28:17.683Z","categories":["563cc7129799fb0d00047689","566f37f37ffa002300c3cd5b","56914e9bd47b020d002225ac","5692b19ffe72e00d00e4f0a8","56940bc2d8c04d1700e5adb6","56940bc83e9d080d00f064f0","56951b2dfcb1032d0089df7a","569522aecaa32519009c410c","569523ce562335190016da97","569523fddcaf0d1700cb86bf","56980e4a8560a60d00e2c3c3","569921a41693520d002e1305","5699323b7465970d00650b82","569e6cc4fbee990d0072d927","56a2768a0aefae0d00b7fe66","5862e862b8b7fa23009665b7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Model T","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-15T16:49:22.988Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"POST /v1/documents HTTP/1.1\nHost: api.drivewealth.io\nx-mysolomeo-session-key: 02e57c7d-d071-4c63-b491-1194a9939ea5.2016-01-13T22:34:53.101Z\nContent-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW\n\n----WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"documentImage\"; filename=\"Screen Shot 2016-01-14 at 1.48.48 PM.png\"\nContent-Type: image/png\n\n\n----WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"documentType\"\n\nPicture ID\n----WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"token\"\n\n02e57c7d-d071-4c63-b491-1194a9939ea5\n----WebKitFormBoundary7MA4YWxkTrZu0gW","language":"http"},{"code":"curl -X POST -H \"x-mysolomeo-session-key: 02e57c7d-d071-4c63-b491-1194a9939ea5.2016-01-13T22:34:53.101Z\" -H \"Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW\" -F \"documentImage=:::at:::Screen Shot 2016-01-14 at 1.48.48 PM.png\" -F \"documentType=Picture ID\" -F \"token=02e57c7d-d071-4c63-b491-1194a9939ea5\" 'https://api.drivewealth.io/v1/documents'","language":"curl"}]},"results":{"codes":[{"status":200,"language":"json","code":"","name":""}]},"settings":"","auth":"required","params":[{"_id":"569923d1cb127f0d003cc0c6","ref":"","in":"body","required":true,"desc":"Use the `userID`.","default":"02e57c7d-d071-4c63-b491-1194a9939ea5","type":"string","name":"token"},{"_id":"569923d1cb127f0d003cc0c5","ref":"","in":"body","required":true,"desc":"Type of document. See [\"Document Types\"](#document-types).","default":"Picture ID","type":"string","name":"documentType"},{"_id":"569923d1cb127f0d003cc0c4","ref":"","in":"body","required":true,"desc":"File contents via `multipart/form-data`.<br />**Accepted File Types**: JPG, GIF, PNG and PDF.","default":"","type":"file","name":"documentImage"}],"url":"/documents"},"isReference":true,"order":6,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Document Types\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Argument\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`\\\"Picture ID\\\"`\",\n    \"0-1\": \"Valid, non-expired picture ID examples:<br /> • Government issued Photo ID<br /> • Valid Driver’s License<br /> • Passport<br /> • Voters Registration Card with photo\",\n    \"1-0\": \"`\\\"Proof of address\\\"`\",\n    \"1-1\": \"Valid Proof of Address examples:<br /> • Utility Bill<br /> • Mobile Phone Bill, Bank or Credit Card Statement<br /><br />**Note**: All Bills and Statements must be within the last 3 months\",\n    \"2-0\": \"`\\\"Picture ID_Proof of address\\\"`\",\n    \"2-1\": \"Valid, non-expired picture ID and proof of address example:<br /> • Valid Driver's License w/ Address<br /> • Government issued Photo ID w/ Address\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Uploaded documents are not reviewed or approved in UAT. In Production, documents are reviewed by DriveWealth's licensed customer service department to verify the user's identity.\",\n  \"title\": \"Document Review Process in UAT vs Production\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nAfter the documents are uploaded, you will receive a 200 success code.","excerpt":"After a user creates a live account they must verify their identity for [KYC](https://en.wikipedia.org/wiki/Know_your_customer) and [AML](http://www.finra.org/industry/issues/anti-money-laundering) purposes by uploading their picture ID and/or proof of address.","slug":"add-document","type":"post","title":"Add Document"}

postAdd Document

After a user creates a live account they must verify their identity for [KYC](https://en.wikipedia.org/wiki/Know_your_customer) and [AML](http://www.finra.org/industry/issues/anti-money-laundering) purposes by uploading their picture ID and/or proof of address.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

token:
required
string02e57c7d-d071-4c63-b491-1194a9939ea5
Use the `userID`.
documentType:
required
stringPicture ID
Type of document. See ["Document Types"](#document-types).
documentImage:
required
file
File contents via `multipart/form-data`.<br />**Accepted File Types**: JPG, GIF, PNG and PDF.

Examples


Documentation

[block:api-header] { "type": "basic", "title": "Document Types" } [/block] [block:parameters] { "data": { "h-0": "Argument", "h-1": "Description", "0-0": "`\"Picture ID\"`", "0-1": "Valid, non-expired picture ID examples:<br /> • Government issued Photo ID<br /> • Valid Driver’s License<br /> • Passport<br /> • Voters Registration Card with photo", "1-0": "`\"Proof of address\"`", "1-1": "Valid Proof of Address examples:<br /> • Utility Bill<br /> • Mobile Phone Bill, Bank or Credit Card Statement<br /><br />**Note**: All Bills and Statements must be within the last 3 months", "2-0": "`\"Picture ID_Proof of address\"`", "2-1": "Valid, non-expired picture ID and proof of address example:<br /> • Valid Driver's License w/ Address<br /> • Government issued Photo ID w/ Address" }, "cols": 2, "rows": 3 } [/block] [block:callout] { "type": "info", "body": "Uploaded documents are not reviewed or approved in UAT. In Production, documents are reviewed by DriveWealth's licensed customer service department to verify the user's identity.", "title": "Document Review Process in UAT vs Production" } [/block] [block:api-header] { "type": "basic", "title": "Response" } [/block] After the documents are uploaded, you will receive a 200 success code.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}