{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"vendor-principal","type":"basic","slug":"vendor-principal","excerpt":"","body":"###Request\n[block:callout]\n{\n  \"type\": \"info\",\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  \"title\": \"Vendor requirements\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`first-name`\",\n    \"1-0\": \"`last-name`\",\n    \"2-0\": \"`address`\",\n    \"4-0\": \"`city`\",\n    \"5-0\": \"`country`\",\n    \"6-0\": \"`zip`\",\n    \"7-0\": \"`dob`\",\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    \"0-2\": \"**Required**\",\n    \"1-1\": \"*string*\",\n    \"1-2\": \"**Required**\",\n    \"2-1\": \"*string*\",\n    \"2-2\": \"**Required**\",\n    \"4-1\": \"*string*\",\n    \"4-2\": \"**Required**\",\n    \"5-1\": \"*string*\",\n    \"5-2\": \"**Required**\",\n    \"6-1\": \"*string*\",\n    \"6-2\": \"**Required**\",\n    \"7-1\": \"*string*\",\n    \"7-2\": \"**Required**\",\n    \"11-1\": \"*string*\",\n    \"11-2\": \"**Required**\",\n    \"0-3\": \"First name of vendor principal owner. Maximum 40 characters.\",\n    \"1-3\": \"Last name of vendor principal owner. Maximum 40 characters.\",\n    \"2-3\": \"Street address of vendor principal owner. Maximum 60 characters.\",\n    \"4-3\": \"City of vendor principal owner. Maximum 40 characters.\",\n    \"5-3\": \"Country code of the vendor principal owner.\\nSee [Country codes](/docs/country-codes)\",\n    \"6-3\": \"Zip of vendor principal owner. Maximum 10 characters.\",\n    \"7-3\": \"Date of birth for 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\": \"`personal-identification-number`\",\n    \"8-1\": \"*string*\",\n    \"8-2\": \"**Required**\",\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\\n Maximum 25 characters.\",\n    \"9-0\": \"`driver-license-number`\",\n    \"9-1\": \"*string*\",\n    \"9-2\": \"**Required** if vendor principal country is US\",\n    \"9-3\": \"Driver license number of vendor principal owner. Maximum 20 alphanumeric characters\",\n    \"10-0\": \"`passport-number`\",\n    \"10-1\": \"*string*\",\n    \"10-2\": \"**Required** if vendor principal country is not US\",\n    \"10-3\": \"Passport number of vendor principal owner. Maximum 20 alphanumeric characters.\"\n  },\n  \"cols\": 4,\n  \"rows\": 12\n}\n[/block]","updates":[],"order":61,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ff4b747849e1b03c506844e","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Resources","slug":"resources","order":16,"from_sync":false,"reference":false,"_id":"5ff4b747849e1b03c5068415","version":"5ff4b747849e1b03c50684c7","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-15T16:20:51.519Z","__v":0},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"version":"8976-XML","version_clean":"8976.0.0-XML","codename":"3.36.1 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ff4b747849e1b03c5068409","5ff4b747849e1b03c506840a","5ff4b747849e1b03c506840b","5ff4b747849e1b03c506840c","5ff4b747849e1b03c506840d","5ff4b747849e1b03c506840e","5ff4b747849e1b03c506840f","5ff4b747849e1b03c5068410","5ff4b747849e1b03c5068411","5ff4b747849e1b03c5068412","5ff4b747849e1b03c5068413","5ff4b747849e1b03c5068414","5ff4b747849e1b03c5068415","5ff4b747849e1b03c5068416","5ff4b747849e1b03c5068417","5ff4b747849e1b03c5068418","5ff4b747849e1b03c5068419","5ff4b747849e1b03c506841a","5ff4b747849e1b03c506841b","5ff4b747849e1b03c506841c"],"_id":"5ff4b747849e1b03c50684c7","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5fd26704abd1b6004f12d72c","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z"},"createdAt":"2016-11-28T16:18:14.337Z","githubsync":"","__v":0}

Payment API (XML)

Card/Wallet Transactions

PayPal Transactions

ACH/ECP Transactions

iDEAL Transactions

Local Bank Transfer transactions

SEPA Direct Debit Transactions

Sofort Transactions

Batch Transactions

Refunds

Vaulted Shoppers

Subscriptions

Fraud Review

Marketplace

Wallets

Errors

Resources

Test Data & Codes

Guides & Tools

Mobile SDK

vendor-principal

Request

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.

Property Name
Type
Required
Description

first-name

string

Required

First name of vendor principal owner. Maximum 40 characters.

last-name

string

Required

Last name of vendor principal owner. Maximum 40 characters.

address

string

Required

Street 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.

country

string

Required

Country code of the vendor principal owner.
See Country codes

zip

string

Required

Zip of vendor principal owner. Maximum 10 characters.

dob

string

Required

Date of birth for vendor principal owner

Format: dd-mm-yyyy

personal-identification-number

string

Required

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.

driver-license-number

string

Required if vendor principal country is US

Driver license number of vendor principal owner. Maximum 20 alphanumeric characters

passport-number

string

Required if vendor principal country is not US

Passport number of vendor principal owner. Maximum 20 alphanumeric characters.

email

string

Required

Email address of vendor principal owner. Maximum 150 characters. "+" character is not permitted.