{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"verification","type":"basic","slug":"verification","excerpt":"Includes information about vendor payout and processing statuses.","body":"###Request\nN/A\n\n###Response\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`payoutStatus`\",\n    \"0-1\": \"*string*\",\n    \"0-2\": \"Vendor [payout status](/docs/vendor-onboarding#section-payout-status). \\n\\nPossible values: \\n* **Incomplete**\\n* **Pending**\\n* **Approved**\\n* **Declined**\",\n    \"1-0\": \"`processingStatus`\",\n    \"1-1\": \"*string*\",\n    \"1-2\": \"Vendor [processing status](/docs/vendor-onboarding#section-processing-status). \\n\\nPossible values: \\n* **Active**\\n* **Inactive**\",\n    \"2-0\": \"`declineReason`\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"Reason for vendor decline (i.e. fraud). \\n\\nReturned when value of `payoutStatus` is **Declined**.\",\n    \"3-0\": \"`missingItems`\",\n    \"3-1\": \"*array*\",\n    \"3-2\": \"Contains the missing vendor information (i.e. [\\\"vendor.phone\\\", \\\"vendor.address\\\"]) \\n\\nReturned when value of `payoutStatus` is **Incomplete**.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","updates":[],"order":64,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"628531cd1258c8003f6dd220","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON Objects","slug":"resources","order":16,"from_sync":false,"reference":false,"_id":"628531cd1258c8003f6dd1ca","version":"628531cd1258c8003f6dd27d","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.42 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["628531cd1258c8003f6dd1bf","628531cd1258c8003f6dd1c0","628531cd1258c8003f6dd1c1","628531cd1258c8003f6dd1c2","628531cd1258c8003f6dd1c3","628531cd1258c8003f6dd1c4","628531cd1258c8003f6dd1c5","628531cd1258c8003f6dd1c6","628531cd1258c8003f6dd1c7","628531cd1258c8003f6dd1c8","628531cd1258c8003f6dd1c9","628531cd1258c8003f6dd1ca","628531cd1258c8003f6dd1cb","628531cd1258c8003f6dd1cc","628531cd1258c8003f6dd1cd","628531cd1258c8003f6dd1ce","628531cd1258c8003f6dd1cf","628531cd1258c8003f6dd1d0","628531cd1258c8003f6dd1d1","628531cd1258c8003f6dd1d2"],"_id":"628531cd1258c8003f6dd27d","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"622783372cd60c003782d77e","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2017-07-05T18:37:44.706Z","githubsync":"","__v":0}

verification

Includes information about vendor payout and processing statuses.

Request

N/A

Response

Property Name
Type
Description

payoutStatus

string

Vendor payout status.

Possible values:

  • Incomplete
  • Pending
  • Approved
  • Declined

processingStatus

string

Vendor processing status.

Possible values:

  • Active
  • Inactive

declineReason

string

Reason for vendor decline (i.e. fraud).

Returned when value of payoutStatus is Declined.

missingItems

array

Contains the missing vendor information (i.e. ["vendor.phone", "vendor.address"])

Returned when value of payoutStatus is Incomplete.