{"_id":"564ab687c58bef0d0062070a","project":"55dd0853d2d97337001800e2","user":"55f84b9660cc850d008a7afc","category":{"_id":"55df7dcd437b3f0d004ba204","pages":["55df7ef3a50de10d00062f70","55e0f40126f51b0d009b171c","55e0f57c7d91840d00824934","55e0f605c13a5a0d00880e6b","55e100eed052580d0038c993","55e1013d26f51b0d009b1759","55e101637d91840d0082493c","55e5f5af9416190d00dc3a59","55e6203dd101191900f30d11","55ea2468ba33bc3500b28cd9","55f85c32a3271b0d00498d51","55f8b70fc449610d002daf9f","56092bafa7cc2f0d00d975b2","56092bd58aedf50d0004cff1","563923d13539050d000820f0","563e732531f7580d00511edf","564a83ec4721851900a67614","564ab6274cd0521700523f17","564ab687c58bef0d0062070a","564ab6ee9f35450d00fc767a","564ab75f33fb500d00567ddd","564ab7c34cd0521700523f19","564ab82233fb500d00567ddf","564b5f0755cfbe0d00de3ba5","564b5f7e55cfbe0d00de3ba7","565cf59677f0090d00581807","565e4266f76b8d0d00554185","565f4119de5dc50d00acfe30","5665c0b8d7490819006a4fd6"],"project":"55dd0853d2d97337001800e2","version":"55de36ec9067202b00de0015","__v":29,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-08-27T21:14:53.972Z","from_sync":false,"order":2,"slug":"customers","title":"Customers"},"version":{"_id":"55de36ec9067202b00de0015","__v":33,"project":"55dd0853d2d97337001800e2","createdAt":"2015-08-26T22:00:12.384Z","releaseDate":"2015-08-26T22:00:12.383Z","categories":["55de36ed9067202b00de0016","55de36ed9067202b00de0017","55de36ed9067202b00de0018","55df7dcd437b3f0d004ba204","55e4e014177b6e0d00333141","55e4e01fe252ac0d00303a99","55e4e05240cda60d003bad67","55e4e070177b6e0d00333142","55e4e0753325e60d007fbee6","55e4e0803325e60d007fbee7","55e4e086177b6e0d00333143","55e4e0a1177b6e0d00333144","55e4e0aa3325e60d007fbee8","55e4e0b140cda60d003bad6b","55e4e0bae252ac0d00303a9d","55e4e0c5177b6e0d00333145","55e4e0ee3325e60d007fbeea","55e4e0fae252ac0d00303a9e","55e4e100177b6e0d00333147","55f85c8ba3271b0d00498d55","56092e1ac5cff70d007d0131","564b64a3ee12850d0095866e","564b64b5791099170071e9ea","565cd0bfd18ae50d007183d8","565f5f5d6bafd40d0030a063","565f790d6bafd40d0030a09f","56611c464851190d003f9f5d","56637d5b7988ab0d00d0522e","56637d687988ab0d00d0522f","567835df6928b40d009dd650","56e59c043c29b117008dae5b","5704013559c5190e000ab646","572be252de40590e00026934","58af1bf6ebd7370f0078ba09","5cdad81d912ece0039e9a939"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3.0"},"parentDoc":null,"githubsync":"","__v":55,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-17T05:09:27.924Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":5,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"\\\"verifications\\\"\",\n  \"body\": \"Depending on the current plan, there will be a set of \\\"verifications\\\" that are required. Generally there is an underwriting verification (\\\"standard\\\" or \\\"professional\\\") and/or a \\\"bank\\\" verification. If the verification has indeed been verified, then it will have a value of \\\"verified\\\", otherwise it will have a value of \\\"unverified\\\". Changing plans may affect the list of verifications.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"\\\"needed\\\"\",\n  \"body\": \"The most common values you may encounter in the \\\"needed\\\" parameter:\\n* **bankDrops**: The bank drops have not yet been initiated. Try adding a bank.\\n* **verifyBankDropAmount**: Bank drops have been initiated and the amounts still need to be verified.\\n* **underwritingData**: We do not yet have enough information to make a informed underwriting decision. Try adding more customer information.\\n\\nIf there are other values in the \\\"needed\\\" parameter, it usually means that we had enough information to start the underwriting process and we are asking for more specific information such as \\\"ssn\\\" or other critical information.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"\\\"status\\\"\",\n  \"body\": \"Status is the most important parameter in the planStatus as its value is used as the ultimate determination of the current plan's state. Depending on the plan, certain features are enabled and disabled depending on whether the status is \\\"unverified\\\" or \\\"verified\\\". Any other status results in all features being disabled. In general, if all \\\"verifications\\\" are set to \\\"verified\\\", then the \\\"status\\\" will also be \\\"verified\\\".\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Specification\",\n    \"h-2\": \"Value Format / Requirements**\",\n    \"h-3\": \"Notes\",\n    \"0-0\": \"plan\",\n    \"0-1\": \"**Type**: String\\n**Example**: PayStand Lite\\n**Description**: The name of the plan.\",\n    \"1-0\": \"status\",\n    \"2-0\": \"verifications\",\n    \"3-0\": \"needed\",\n    \"3-1\": \"**Type**: Array of Strings\\n**Examples**: \\\"verifyBankDropAmounts\\\"\\n**Description**: Any outstanding verifications that are needed for the customer's plan status to become verified.\",\n    \"2-1\": \"**Type**: JSON object\\n**Description**: The verifications for this plan and whether they have been verified.\",\n    \"1-1\": \"**Type**: String\\n**Example**: verified\\n**Description**: The plan status.\",\n    \"0-3\": \"The name of the plan\",\n    \"1-3\": \"\",\n    \"2-3\": \"\",\n    \"3-3\": \"\",\n    \"3-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\t\\\"customer\\\": {\\n\\t\\t\\\"planStatus\\\": {\\n    \\t\\\"plan\\\": \\\"Paystand Enterprise\\\",\\n      \\\"status\\\": \\\"verified\\\",\\n      \\\"verifications\\\": {\\n      \\t\\\"bank\\\": \\\"unverified\\\",\\n        \\\"professional\\\": \\\"verified\\\"\\n      },\\n      \\\"needed\\\": [\\\"verifyBankDropAmounts\\\"]\\n    }\\n\\t}\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n### Plan status state diagram\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/323Jh5xVSgeoArY32OEc_Plan%20State%20Diagram.svg\",\n        \"Plan State Diagram.svg\",\n        \"0\",\n        \"0\",\n        \"#323232\",\n        \"\"\n      ],\n      \"caption\": \"customer.planStatus.status diagram\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"PlanStatus status\",\n  \"body\": \"* **incomplete**: Not enough information has been provided to begin the verification process.\\n* **unverified**: Verification was unsuccessful and more information is required. These requirements will be listed under the needed field.\\n* **verified**: The customer is verified and has everything enabled under the verified section of their plan.\\n* **denied**: The customer has been denied. This usually means that the account is fraudulent. Customer will not be able to conduct any transactions.\",\n  \"sidebar\": true\n}\n[/block]","excerpt":"The planStatus object","slug":"customer-plan-status","type":"basic","title":"Customer.planStatus"}

Customer.planStatus

The planStatus object

[block:callout] { "type": "warning", "title": "\"verifications\"", "body": "Depending on the current plan, there will be a set of \"verifications\" that are required. Generally there is an underwriting verification (\"standard\" or \"professional\") and/or a \"bank\" verification. If the verification has indeed been verified, then it will have a value of \"verified\", otherwise it will have a value of \"unverified\". Changing plans may affect the list of verifications." } [/block] [block:callout] { "type": "warning", "title": "\"needed\"", "body": "The most common values you may encounter in the \"needed\" parameter:\n* **bankDrops**: The bank drops have not yet been initiated. Try adding a bank.\n* **verifyBankDropAmount**: Bank drops have been initiated and the amounts still need to be verified.\n* **underwritingData**: We do not yet have enough information to make a informed underwriting decision. Try adding more customer information.\n\nIf there are other values in the \"needed\" parameter, it usually means that we had enough information to start the underwriting process and we are asking for more specific information such as \"ssn\" or other critical information." } [/block] [block:callout] { "type": "success", "title": "\"status\"", "body": "Status is the most important parameter in the planStatus as its value is used as the ultimate determination of the current plan's state. Depending on the plan, certain features are enabled and disabled depending on whether the status is \"unverified\" or \"verified\". Any other status results in all features being disabled. In general, if all \"verifications\" are set to \"verified\", then the \"status\" will also be \"verified\"." } [/block] [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Specification", "h-2": "Value Format / Requirements**", "h-3": "Notes", "0-0": "plan", "0-1": "**Type**: String\n**Example**: PayStand Lite\n**Description**: The name of the plan.", "1-0": "status", "2-0": "verifications", "3-0": "needed", "3-1": "**Type**: Array of Strings\n**Examples**: \"verifyBankDropAmounts\"\n**Description**: Any outstanding verifications that are needed for the customer's plan status to become verified.", "2-1": "**Type**: JSON object\n**Description**: The verifications for this plan and whether they have been verified.", "1-1": "**Type**: String\n**Example**: verified\n**Description**: The plan status.", "0-3": "The name of the plan", "1-3": "", "2-3": "", "3-3": "", "3-2": "" }, "cols": 2, "rows": 4 } [/block] [block:code] { "codes": [ { "code": "{\n\t\"customer\": {\n\t\t\"planStatus\": {\n \t\"plan\": \"Paystand Enterprise\",\n \"status\": \"verified\",\n \"verifications\": {\n \t\"bank\": \"unverified\",\n \"professional\": \"verified\"\n },\n \"needed\": [\"verifyBankDropAmounts\"]\n }\n\t}\n}", "language": "json", "name": "Response" } ], "sidebar": true } [/block] ### Plan status state diagram [block:image] { "images": [ { "image": [ "https://files.readme.io/323Jh5xVSgeoArY32OEc_Plan%20State%20Diagram.svg", "Plan State Diagram.svg", "0", "0", "#323232", "" ], "caption": "customer.planStatus.status diagram" } ] } [/block] [block:callout] { "type": "info", "title": "PlanStatus status", "body": "* **incomplete**: Not enough information has been provided to begin the verification process.\n* **unverified**: Verification was unsuccessful and more information is required. These requirements will be listed under the needed field.\n* **verified**: The customer is verified and has everything enabled under the verified section of their plan.\n* **denied**: The customer has been denied. This usually means that the account is fraudulent. Customer will not be able to conduct any transactions.", "sidebar": true } [/block]