{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"vendorPrincipal","type":"basic","slug":"vendorprincipal","excerpt":"","body":"###Request\n[block:callout]\n{\n \"type\": \"info\",\n \"title\": \"Vendor requirements\",\n \"body\": \"Initially, you do not need all your vendor's information to submit the request to immediately begin processing transactions; **however**, to fully board your vendor, you must collect all the necessary Know Your Customer (KYC), banking, and any additional required information from them, and submit to BlueSnap for verification.\"\n}\n[/block]\n\n[block:parameters]\n{\n \"data\": {\n \"0-0\": \"`firstName`\",\n \"2-0\": \"`address`\",\n \"4-0\": \"`city`\",\n \"5-0\": \"`country`\",\n \"7-0\": \"`dob`\",\n \"1-0\": \"`lastName`\",\n \"6-0\": \"`zip`\",\n \"11-0\": \"`email`\",\n \"h-0\": \"Property Name\",\n \"h-1\": \"Type\",\n \"h-2\": \"Required\",\n \"h-3\": \"Description\",\n \"0-1\": \"*string*\",\n \"1-1\": \"*string*\",\n \"2-1\": \"*string*\",\n \"4-1\": \"*string*\",\n \"5-1\": \"*string*\",\n \"6-1\": \"*string*\",\n \"11-1\": \"*string*\",\n \"7-1\": \"*string*\",\n \"0-2\": \"**Required**\",\n \"1-2\": \"**Required**\",\n \"2-2\": \"**Required**\",\n \"4-2\": \"**Required**\",\n \"6-2\": \"**Required**\",\n \"7-2\": \"**Required**\",\n \"11-2\": \"**Required**\",\n \"5-2\": \"**Required**\",\n \"0-3\": \"First name of vendor principal owner. Maximum 40 characters.\",\n \"2-3\": \"Address of vendor principal owner. Maximum 60 characters.\",\n \"1-3\": \"Last name of vendor principal owner. Maximum 40 characters.\",\n \"4-3\": \"City of vendor principal owner. Maximum 40 characters.\",\n \"5-3\": \"Country code of vendor principal owner. See [Country Codes](doc:country-codes).\",\n \"6-3\": \"Zip of vendor principal owner. Maximum 10 characters.\",\n \"7-3\": \"Date of Birth of vendor principal owner\\n\\nFormat: dd-mm-yyyy\",\n \"11-3\": \"Email address of vendor principal owner. Maximum 150 characters. \\\"+\\\" character is not permitted.\",\n \"3-0\": \"`address2`\",\n \"3-1\": \"*string*\",\n \"3-2\": \"Optional\",\n \"3-3\": \"Address line 2 of vendor principal owner. Maximum 60 characters.\",\n \"8-0\": \"`personalIdentificationNumber`\",\n \"8-1\": \"*string*\",\n \"8-2\": \"**Required** if vendor principal country is US\",\n \"8-3\": \"In the US, this value is the last four digits of the principal owner's Social Security Number. \\n\\nIn countries outside of the US, this value is the full National Identification Number of the principal owner, or TaxID if the country doesn’t support a National Identification Number. \\n\\nMaximum 25 characters.\\n\\n**Note**: If the vendor principal country is not the US, only one of `personalIdentificationNumber`, `driverLicenseNumber` or `passportNumber` is required.\",\n \"9-0\": \"`driverLicenseNumber`\",\n \"9-1\": \"*string*\",\n \"9-2\": \"**Optional**\",\n \"9-3\": \"Driver license number of vendor principal owner. Maximum 20 alphanumeric characters.\\n\\n**Note**: If the vendor principal country is not the US, only one of `personalIdentificationNumber`, `driverLicenseNumber` or `passportNumber` is required.\",\n \"10-0\": \"`passportNumber`\",\n \"10-1\": \"*string*\",\n \"10-2\": \"**Optional**\",\n \"10-3\": \"Passport number of vendor principal owner. Maximum 20 alphanumeric characters.\\n\\n**Note**: If the vendor principal country is not the US, only one of `personalIdentificationNumber`, `driverLicenseNumber` or `passportNumber` is required.\"\n },\n \"cols\": 4,\n \"rows\": 12\n}\n[/block]","updates":[],"order":58,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"628531cd1258c8003f6dd21a","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":"2016-12-02T17:06:33.565Z","githubsync":"","__v":0}
vendorPrincipal
Vendor requirements
Initially, you do not need all your vendor's information to submit the request to immediately begin processing transactions; however, to fully board your vendor, you must collect all the necessary Know Your Customer (KYC), banking, and any additional required information from them, and submit to BlueSnap for verification.
firstName
string
Required
First name of vendor principal owner. Maximum 40 characters.
lastName
string
Required
Last name of vendor principal owner. Maximum 40 characters.
address
string
Required
Address of vendor principal owner. Maximum 60 characters.
address2
string
Optional
Address line 2 of vendor principal owner. Maximum 60 characters.
city
string
Required
City of vendor principal owner. Maximum 40 characters.
zip
string
Required
Zip of vendor principal owner. Maximum 10 characters.
dob
string
Required
Date of Birth of vendor principal owner
Format: dd-mm-yyyy
personalIdentificationNumber
string
Required if vendor principal country is US
In the US, this value is the last four digits of the principal owner's Social Security Number.
In countries outside of the US, this value is the full National Identification Number of the principal owner, or TaxID if the country doesn’t support a National Identification Number.
Maximum 25 characters.
Note: If the vendor principal country is not the US, only one of personalIdentificationNumber
, driverLicenseNumber
or passportNumber
is required.
driverLicenseNumber
string
Optional
Driver license number of vendor principal owner. Maximum 20 alphanumeric characters.
Note: If the vendor principal country is not the US, only one of personalIdentificationNumber
, driverLicenseNumber
or passportNumber
is required.
passportNumber
string
Optional
Passport number of vendor principal owner. Maximum 20 alphanumeric characters.
Note: If the vendor principal country is not the US, only one of personalIdentificationNumber
, driverLicenseNumber
or passportNumber
is required.
email
string
Required
Email address of vendor principal owner. Maximum 150 characters. "+" character is not permitted.