{"_id":"572a13b2d10a200e00b1cace","user":"563cc6fa8894d20d00014ea3","editedParams2":true,"editedParams":true,"parentDoc":null,"category":{"_id":"5692b19ffe72e00d00e4f0a8","__v":10,"pages":["5692b1ec72d4580d0081e96b","5692b39b72d4580d0081e96f","56951b250c650a2300250544","569520590c650a2300250553","56952277caa32519009c410a","569523782e5eb41700901a7e","56992a43de42370d00727c7c","56b8acb443bbd10d0081d148","56ec413636bc8e0e00f190e3","56ec46068fac371700005d12"],"project":"563cc7119799fb0d00047685","version":"563cc7119799fb0d00047688","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-10T19:31:43.021Z","from_sync":false,"order":13,"slug":"fix-api","title":"Users"},"project":"563cc7119799fb0d00047685","__v":0,"version":{"_id":"563cc7119799fb0d00047688","__v":18,"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","592835c7bc8bca0f000cc9ff","596f693df43cca002e690e1c"],"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-05-04T15:22:26.154Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"http","code":"POST /v1/users/multi-status-fetch HTTP/1.1\nHost: api.drivewealth.io\nAccept: application/json\nContent-Type: application/json\n\n{\n    \"userIDList\": \n    [\n        {\n            \"userID\" : \"23748734-7025-4616-b115-fffed94f349a\"\n        },{\n            \"userID\" : \"b8a6d6c1-7c99-4cf6-889e-61be90ec5766\"\n        },{\n            \"userID\" : \"dca368a8-a9b0-4834-a662-51d540c6da5a\"\n        }\n    ]\n}"},{"language":"curl","code":"curl -X POST -H \"Accept: application/json\" -H \"Content-Type: application/json\" -H \"x-mysolomeo-session-key: 02e57c7d-d071-4c63-b491-1194a9939ea5.2016-01-20T20:50:48.680Z\" -d '{\n    \"userIDList\": \n    [\n        {\n            \"userID\" : \"23748734-7025-4616-b115-fffed94f349a\"\n        },{\n            \"userID\" : \"b8a6d6c1-7c99-4cf6-889e-61be90ec5766\"\n        },{\n            \"userID\" : \"dca368a8-a9b0-4834-a662-51d540c6da5a\"\n        }\n    ]\n}' \"http://api.drivewealth.io/v1/users/multi-status-fetch\""}]},"method":"post","results":{"codes":[{"name":"","code":"{\n    \"userStatusModels\": [\n        {\n            \"accountStatus\": 1,\n            \"accountReason\": \" Documents PENDING.\",\n            \"accountReasonID\": 2,\n            \"addressProofStatus\": 1,\n            \"addressProofReason\": \"Proof of Address is PENDING for review.\",\n            \"addressProofReasonID\": 0,\n            \"idStatus\": 1,\n            \"idReason\": \"Picture ID is PENDING for review.\",\n            \"idReasonID\": 0,\n            \"kycWhen\": \"2015-08-27T12:00:00Z\",\n            \"kycStatus\": 2,\n            \"userID\": \"23748734-7025-4616-b115-fffed94f349a\"\n        },\n        {\n            \"accountStatus\": 1,\n            \"accountReason\": \" Documents PENDING. Background check PENDING.\",\n            \"accountReasonID\": 5,\n            \"addressProofStatus\": 0,\n            \"addressProofReason\": \"Proof of Address is NOT submitted.\",\n            \"addressProofReasonID\": 0,\n            \"idStatus\": 0,\n            \"idReason\": \"Picture ID is NOT submitted.\",\n            \"idReasonID\": 0,\n            \"kycStatus\": 1,\n            \"userID\": \"b8a6d6c1-7c99-4cf6-889e-61be90ec5766\"\n        },\n        {\n            \"accountStatus\": 0,\n            \"accountReason\": \"\",\n            \"accountReasonID\": 0,\n            \"addressProofStatus\": 0,\n            \"addressProofReason\": \"Proof of Address is NOT submitted.\",\n            \"addressProofReasonID\": 0,\n            \"idStatus\": 0,\n            \"idReason\": \"Picture ID is NOT submitted.\",\n            \"idReasonID\": 0,\n            \"kycStatus\": 1,\n            \"userID\": \"dca368a8-a9b0-4834-a662-51d540c6da5a\"\n        }\n    ]\n}","language":"json","status":200},{"name":"No users found","code":"{\n    \"code\": 404,\n    \"message\": \"No users were found.\"\n}","language":"json","status":404},{"code":"{\n    \"userStatusModels\": [\n        {\n            \"userID\": \"23748734-7025-4616-b1215-fffed94f349a\",\n            \"errorMessage\": \"User not found\"\n        },\n        {\n            \"accountStatus\": 1,\n            \"accountReason\": \" Documents PENDING. Background check PENDING.\",\n            \"accountReasonID\": 5,\n            \"addressProofStatus\": 0,\n            \"addressProofReason\": \"Proof of Address is NOT submitted.\",\n            \"addressProofReasonID\": 0,\n            \"idStatus\": 0,\n            \"idReason\": \"Picture ID is NOT submitted.\",\n            \"idReasonID\": 0,\n            \"kycStatus\": 1,\n            \"userID\": \"b8a6d6c1-7c99-4cf6-889e-61be90ec5766\"\n        },\n        {\n            \"userID\": \"dca368a8-a9b0-4834-a6621-51d540c6da5a\",\n            \"errorMessage\": \"User not found\"\n        }\n    ]\n}","language":"json","status":404,"name":"At least one user not found"}]},"settings":"","auth":"required","params":[{"_id":"56992a9203721e0d0043a3f8","ref":"","in":"body","required":true,"desc":"User ID.","default":"{             \"userID\" : \"23748734-7025-4616-b115-fffed94f349a\"         },{             \"userID\" : \"b8a6d6c1-7c99-4cf6-889e-61be90ec5766\"         },{             \"userID\" : \"dca368a8-a9b0-4834-a662-51d540c6da5a\"         }","type":"array_string","name":"userIDList"}],"url":"/users/multi-status-fetch"},"isReference":true,"order":4,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nReturns a single user object. Every user has a default list of attributes.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`accountStatus`\",\n    \"1-0\": \"`accountReasonID`\",\n    \"2-0\": \"`accountReason`\",\n    \"3-0\": \"`accountApprovedWhen`\",\n    \"4-0\": \"`addressProofReviewWhen`\",\n    \"5-0\": \"`addressProofStatus`\",\n    \"6-0\": \"`addressProofReasonID`\",\n    \"7-0\": \"`addressProofReason`\",\n    \"8-0\": \"`idReviewWhen`\",\n    \"9-0\": \"`idStatus`\",\n    \"10-0\": \"`idReasonID`\",\n    \"11-0\": \"`idReason`\",\n    \"12-0\": \"`kycWhen`\",\n    \"13-0\": \"`kycStatus`\",\n    \"0-1\": \"Overall account status.<br />**Options**: `1` - Pending, `2` - Approved, `3` - Rejected, `4` - Revoked, or `5` - Closed.\",\n    \"1-1\": \"Reason for account status.\",\n    \"2-1\": \"Specific information on `accountReasonID`. See [Account Reason Matrix](#account-reason-matrix) below for all descriptions.\",\n    \"3-1\": \"Timestamp (in UTC format) when account was approved.\",\n    \"4-1\": \"Timestamp (in UTC format) when address proof was approved.\",\n    \"5-1\": \"Address proof status.<br /> **Options**: `0` - Not Submitted, `1` - Pending, `2` - Approved, or `3` - Rejected.\",\n    \"6-1\": \"Reason for address proof status. Should only be observed when `addressProofStatus` is set to `3`.\",\n    \"7-1\": \"Specific information on `addressProofReasonID`. Should only be observed when `addressProofStatus` is set to `3`. See [Address Proof Matrix](#address-proof-matrix) below for all descriptions.\",\n    \"8-1\": \"Timestamp (in UTC format) when picture ID was approved.\",\n    \"9-1\": \"Picture ID status.<br /> **Options**: `0` - Not Submitted, `1` - Pending, `2` - Approved, or `3` - Rejected.\",\n    \"10-1\": \"Reason for picture ID status. should only be observed when `idStatus` is set to `3`.\",\n    \"11-1\": \"Specific information on `idReasonID`. Should only be observed when `idStatus` is set to `3`. See [Picture ID Matrix](#picture-id-matrix) below for all descriptions.\",\n    \"12-1\": \"Timestamp (in UTC format) when account was KYC'd.\",\n    \"13-1\": \"KYC status.<br />**Options**: `1` - Pending or `2` - Approved.\"\n  },\n  \"cols\": 2,\n  \"rows\": 14\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Account Reason Matrix\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"accountReasonID\",\n    \"h-1\": \"accountReason\",\n    \"0-0\": \"`1`\",\n    \"0-1\": \"\\\"The customer has been approved!\\\"\",\n    \"1-1\": \"\\\"Documents PENDING.\\\"\",\n    \"2-1\": \"\\\"Background check PENDING.\\\"\",\n    \"3-1\": \"\\\"Compliance review in progress.\\\"\",\n    \"4-1\": \"\\\"Documents PENDING.  Background check PENDING.\\\"\",\n    \"1-0\": \"`2`\",\n    \"2-0\": \"`3`\",\n    \"3-0\": \"`4`\",\n    \"4-0\": \"`5`\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Address Proof Matrix\"\n}\n[/block]\nWhen the `addressProofStatus` is set to `3` (aka \"Rejected\"), the `addressProofReasonID` and `addressProofReason` should be observed.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"addressProofReasonID\",\n    \"h-1\": \"addressProofReason\",\n    \"0-0\": \"`0`\",\n    \"1-0\": \"`1`\",\n    \"2-0\": \"`2`\",\n    \"3-0\": \"`3`\",\n    \"4-0\": \"`4`\",\n    \"5-0\": \"`5`\",\n    \"6-0\": \"`6`\",\n    \"7-0\": \"`7`\",\n    \"0-1\": \"\\\"Proof of Address : Other\\\"\",\n    \"1-1\": \"\\\"Proof of Address : Does not contain Proof of Address\\\"\",\n    \"2-1\": \"\\\"Proof of Address : Proof of Address does not match address on file\\\"\",\n    \"3-1\": \"\\\"Proof of Address : Cannot read image\\\"\",\n    \"4-1\": \"\\\"Proof of Address : Name does not match customer name\\\"\",\n    \"5-1\": \"\\\"Proof of Address : Not a valid form of Proof of Address\\\"\",\n    \"6-1\": \"\\\"Proof of Address : Not a valid form of Picture ID\\\"\",\n    \"7-1\": \"\\\"Proof of Address : Document expired\\\"\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Picture ID Matrix\"\n}\n[/block]\nWhen the `idStatus` is set to `3` (aka \"Rejected\"), the `idReasonID` and `idReason` should be observed.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"idReasonID\",\n    \"h-1\": \"idReason\",\n    \"0-0\": \"`0`\",\n    \"1-0\": \"`1`\",\n    \"2-0\": \"`2`\",\n    \"2-1\": \"\\\"Picture ID : Proof of Address does not match address on file\\\"\",\n    \"3-0\": \"`3`\",\n    \"4-0\": \"`4`\",\n    \"5-0\": \"`5`\",\n    \"6-0\": \"`6`\",\n    \"7-0\": \"`7`\",\n    \"0-1\": \"\\\"Picture ID : Other\\\"\",\n    \"1-1\": \"\\\"Picture ID : Does not contain Proof of Address\\\"\",\n    \"3-1\": \"\\\"Picture ID : Cannot read image\\\"\",\n    \"4-1\": \"\\\"Picture ID : Name does not match customer name\\\"\",\n    \"5-1\": \"\\\"Picture ID : Not a valid form of Proof of Address\\\"\",\n    \"6-1\": \"\\\"Picture ID : Not a valid form of Picture ID\\\"\",\n    \"7-1\": \"\\\"Picture ID : Document expired\\\"\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]","excerpt":"Query multiple user statuses at once.","slug":"multiple-users-status","type":"endpoint","title":"Multiple Users Status"}

postMultiple Users Status

Query multiple user statuses at once.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

userIDList:
required
array of strings{ "userID" : "23748734-7025-4616-b115-fffed94f349a" },{ "userID" : "b8a6d6c1-7c99-4cf6-889e-61be90ec5766" },{ "userID" : "dca368a8-a9b0-4834-a662-51d540c6da5a" }
User ID.

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Response" } [/block] Returns a single user object. Every user has a default list of attributes. [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`accountStatus`", "1-0": "`accountReasonID`", "2-0": "`accountReason`", "3-0": "`accountApprovedWhen`", "4-0": "`addressProofReviewWhen`", "5-0": "`addressProofStatus`", "6-0": "`addressProofReasonID`", "7-0": "`addressProofReason`", "8-0": "`idReviewWhen`", "9-0": "`idStatus`", "10-0": "`idReasonID`", "11-0": "`idReason`", "12-0": "`kycWhen`", "13-0": "`kycStatus`", "0-1": "Overall account status.<br />**Options**: `1` - Pending, `2` - Approved, `3` - Rejected, `4` - Revoked, or `5` - Closed.", "1-1": "Reason for account status.", "2-1": "Specific information on `accountReasonID`. See [Account Reason Matrix](#account-reason-matrix) below for all descriptions.", "3-1": "Timestamp (in UTC format) when account was approved.", "4-1": "Timestamp (in UTC format) when address proof was approved.", "5-1": "Address proof status.<br /> **Options**: `0` - Not Submitted, `1` - Pending, `2` - Approved, or `3` - Rejected.", "6-1": "Reason for address proof status. Should only be observed when `addressProofStatus` is set to `3`.", "7-1": "Specific information on `addressProofReasonID`. Should only be observed when `addressProofStatus` is set to `3`. See [Address Proof Matrix](#address-proof-matrix) below for all descriptions.", "8-1": "Timestamp (in UTC format) when picture ID was approved.", "9-1": "Picture ID status.<br /> **Options**: `0` - Not Submitted, `1` - Pending, `2` - Approved, or `3` - Rejected.", "10-1": "Reason for picture ID status. should only be observed when `idStatus` is set to `3`.", "11-1": "Specific information on `idReasonID`. Should only be observed when `idStatus` is set to `3`. See [Picture ID Matrix](#picture-id-matrix) below for all descriptions.", "12-1": "Timestamp (in UTC format) when account was KYC'd.", "13-1": "KYC status.<br />**Options**: `1` - Pending or `2` - Approved." }, "cols": 2, "rows": 14 } [/block] [block:api-header] { "type": "basic", "title": "Account Reason Matrix" } [/block] [block:parameters] { "data": { "h-0": "accountReasonID", "h-1": "accountReason", "0-0": "`1`", "0-1": "\"The customer has been approved!\"", "1-1": "\"Documents PENDING.\"", "2-1": "\"Background check PENDING.\"", "3-1": "\"Compliance review in progress.\"", "4-1": "\"Documents PENDING. Background check PENDING.\"", "1-0": "`2`", "2-0": "`3`", "3-0": "`4`", "4-0": "`5`" }, "cols": 2, "rows": 5 } [/block] [block:api-header] { "type": "basic", "title": "Address Proof Matrix" } [/block] When the `addressProofStatus` is set to `3` (aka "Rejected"), the `addressProofReasonID` and `addressProofReason` should be observed. [block:parameters] { "data": { "h-0": "addressProofReasonID", "h-1": "addressProofReason", "0-0": "`0`", "1-0": "`1`", "2-0": "`2`", "3-0": "`3`", "4-0": "`4`", "5-0": "`5`", "6-0": "`6`", "7-0": "`7`", "0-1": "\"Proof of Address : Other\"", "1-1": "\"Proof of Address : Does not contain Proof of Address\"", "2-1": "\"Proof of Address : Proof of Address does not match address on file\"", "3-1": "\"Proof of Address : Cannot read image\"", "4-1": "\"Proof of Address : Name does not match customer name\"", "5-1": "\"Proof of Address : Not a valid form of Proof of Address\"", "6-1": "\"Proof of Address : Not a valid form of Picture ID\"", "7-1": "\"Proof of Address : Document expired\"" }, "cols": 2, "rows": 8 } [/block] [block:api-header] { "type": "basic", "title": "Picture ID Matrix" } [/block] When the `idStatus` is set to `3` (aka "Rejected"), the `idReasonID` and `idReason` should be observed. [block:parameters] { "data": { "h-0": "idReasonID", "h-1": "idReason", "0-0": "`0`", "1-0": "`1`", "2-0": "`2`", "2-1": "\"Picture ID : Proof of Address does not match address on file\"", "3-0": "`3`", "4-0": "`4`", "5-0": "`5`", "6-0": "`6`", "7-0": "`7`", "0-1": "\"Picture ID : Other\"", "1-1": "\"Picture ID : Does not contain Proof of Address\"", "3-1": "\"Picture ID : Cannot read image\"", "4-1": "\"Picture ID : Name does not match customer name\"", "5-1": "\"Picture ID : Not a valid form of Proof of Address\"", "6-1": "\"Picture ID : Not a valid form of Picture ID\"", "7-1": "\"Picture ID : Document expired\"" }, "cols": 2, "rows": 8 } [/block]

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 }}