Sample collection and verification responses
Last updated: June 20th 2023, @ 3:08:42 pm
There are different data collection and verification requirements that merchant accounts must meet in order to transact. This page provides sample requests and responses showing different collection and verification errors.
No phone number provided
The sample response shows a response when no phone number is provided for the account's primary authorized user or business info.
Sample response
1{2 {"account_id": "7CC9G7DBKBKQ8",3 "legal_country_code": "US",4 "individual_owners": [5 {6 "id": "7CC9G7DBKBKQ8",7 "names": [8 {9 "given_name": "Mary",10 "surname": "Collins",11 "id": "GSR6TABVCMC2C",12 "type": "LEGAL"13 }14 ],15 "citizenship": "US",16 "primary_residence": {17 "address_line_1": "1234 Lane1 Drive",18 "admin_area_2": "100",19 "postal_code": "95014",20 "country_code": "US"21 },22 "birth_details": {23 "date_of_birth": "1995-05-30"24 },25 "identification_documents": [26 {27 "id": "CMQCDV2M5JWVJ",28 "identification_number": "****",29 "issuing_country_code": "US",30 "type": "SOCIAL_SECURITY_NUMBER"31 }32 ],33 "emails": [34 {35 "id": "YZ8GALAJQH8J4",36 "email": "[email protected]"37 }38 ]39 }40 ],41 "business_entity": {42 "type": "PRIVATE_CORPORATION",43 "merchant_category_code": "5933",44 "incorporation_details": {},45 "names": [46 {47 "business_name": "Demo",48 "id": "GAHAZLB6C9ELJ",49 "type": "LEGAL"50 }51 ],52 "emails": [53 {54 "id": "SATT8L28QQ7V6",55 "email": "[email protected]"56 }57 ],58 "registered_business_address": {59 "address_line_1": "Campus 611 - 1876",60 "address_line_2": "West Seattle",61 "admin_area_2": "Seattle",62 "admin_area_1": "WA",63 "postal_code": "98109",64 "country_code": "US"65 },66 "identification_documents": [67 {68 "id": "9BR258VSEMMT8",69 "identification_number": "****",70 "issuing_country_code": "US",71 "type": "EMPLOYER_IDENTIFICATION_NUMBER"72 }73 ],74 "beneficial_owners": {75 "individuals": [76 {77 "id": "DPM56WSEDKTPE",78 "names": [79 {80 "given_name": "Another oneaa",81 "surname": "Collins",82 "id": "ET5MQT6PJPYUN",83 "type": "LEGAL"84 }85 ],86 "citizenship": "US",87 "addresses": [88 {89 "address_line_1": "Campus 611 - 1876",90 "address_line_2": "West Seattle",91 "admin_area_2": "Seattle",92 "admin_area_1": "WA",93 "postal_code": "98109",94 "country_code": "US",95 "id": "K4NW8JXVNHQ2L",96 "type": "HOME"97 }98 ],99 "birth_details": {100 "date_of_birth": "1990-01-01"101 },102 "identification_documents": [103 {104 "id": "JDJSQHWKMFENJ",105 "identification_number": "****",106 "issuing_country_code": "US",107 "type": "SOCIAL_SECURITY_NUMBER"108 }109 ],110 "emails": [111 {112 "email": "[email protected]"113 }114 ],115 "percentage_of_ownership": "30",116 "controlling_influence": false117 }118 ]119 },120 "office_bearers": [121 {122 "id": "PBEZA228P4UFG",123 "names": [124 {125 "given_name": "Another oneaa",126 "surname": "Collins",127 "id": "FAMYM94JVB3LJ",128 "type": "LEGAL"129 }130 ],131 "citizenship": "US",132 "addresses": [133 {134 "address_line_1": "Campus 611 - 1876",135 "address_line_2": "West Seattle",136 "admin_area_2": "Seattle",137 "admin_area_1": "WA",138 "postal_code": "98109",139 "country_code": "US",140 "id": "JUZKP9L5SRUUS",141 "type": "HOME"142 }143 ],144 "birth_details": {145 "date_of_birth": "1990-01-01"146 },147 "identification_documents": [148 {149 "id": "WJ84S5M54MD6C",150 "identification_number": "****",151 "issuing_country_code": "US",152 "type": "SOCIAL_SECURITY_NUMBER"153 }154 ],155 "emails": [156 {157 "email": "[email protected]"158 }159 ]160 }161 ],162 "declarations": [163 {164 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",165 "value": "YES"166 }167 ]168 },169 "agreements": [170 {171 "type": "TERMS_ACCEPTED",172 "accepted_time": "2019-06-02T01:23:45Z"173 }174 ],175 "balances": [176 {177 "available": {178 "currency_code": "USD",179 "value": "0.00"180 },181 "reserved": {182 "currency_code": "USD",183 "value": "0.00"184 }185 }186 ],187 "external_id": "EXT-1693457671",188 "organization": "us_org/net",189 "user_id": "1693457670903",190 "primary_currency_code": "USD",191 "soft_descriptor": "DEMO",192 "capabilities": [193 {194 "name": "APPLE_PAY",195 "status": "ACTIVE"196 },197 {198 "name": "CUSTOM_CARD_PROCESSING",199 "status": "ACTIVE"200 },201 {202 "name": "RECEIVE_MONEY",203 "status": "ACTIVE"204 },205 {206 "name": "WITHDRAW_MONEY",207 "status": "ACTIVE"208 }209 ],210 "process_view": {211 "processes": [212 {213 "name": "MANAGED_PATH_BO_VERIFICATION",214 "status": "COMPLETED",215 "capabilities": [216 {217 "name": "CUSTOM_CARD_PROCESSING"218 },219 {220 "name": "WITHDRAW_MONEY"221 },222 {223 "name": "APPLE_PAY"224 }225 ]226 },227 {228 "name": "MANAGED_PATH_KYC",229 "status": "COMPLETED",230 "capabilities": [231 {232 "name": "CUSTOM_CARD_PROCESSING"233 },234 {235 "name": "WITHDRAW_MONEY"236 },237 {238 "name": "APPLE_PAY"239 }240 ]241 }242 ]243 },244 "links": [245 {246 "href": "https://api-m.sandbox.paypal.com/v3/customer/managed-accounts/7CC9G7DBKBKQ8",247 "rel": "self",248 "method": "GET"249 },250 {251 "href": "https://api-m.sandbox.paypal.com/v3/customer/managed-accounts/7CC9G7DBKBKQ8",252 "rel": "edit",253 "method": "PATCH"254 },255 {256 "href": "https://api-m.sandbox.paypal.com/v3/customer/managed-accounts/7CC9G7DBKBKQ8/wallet-domains?page=1",257 "rel": "wallet-domains",258 "method": "GET"259 }260 ]}
No email provided
The following sample response shows the error that is returned if you don't provide an email address for individual_owners. Any other entity will result in the standard NEED_MORE_DATA response.
Sample response
- Corporation
- Sole Proprietorship
1{2 {"account_id": "96Z6XGVFD75X8",3 "legal_country_code": "US",4 "individual_owners": [5 {6 "id": "96Z6XGVFD75X8",7 "names": [8 {9 "given_name": "Mary",10 "surname": "Collins",11 "id": "FU2DXXTVA8LK6",12 "type": "LEGAL"13 }14 ],15 "citizenship": "US",16 "primary_residence": {17 "address_line_1": "1234 Lane1 Drive",18 "admin_area_2": "100",19 "postal_code": "95014",20 "country_code": "US"21 },22 "phone_numbers": [23 {24 "country_code": "030",25 "national_number": "6151175",26 "id": "ZEKVC47JJYJXE",27 "type": "MOBILE"28 }29 ],30 "birth_details": {31 "date_of_birth": "1995-05-30"32 },33 "identification_documents": [34 {35 "id": "JQZ6BMYQ5MZTQ",36 "identification_number": "****",37 "issuing_country_code": "US",38 "type": "SOCIAL_SECURITY_NUMBER"39 }40 ],41 "emails": [42 {43 "id": "TLQKG8J4R26N6",44 "email": "[email protected]"45 }46 ]47 }48 ],49 "business_entity": {50 "type": "PRIVATE_CORPORATION",51 "merchant_category_code": "5933",52 "incorporation_details": {},53 "names": [54 {55 "business_name": "Demo",56 "id": "7VDTDQLBEUSLE",57 "type": "LEGAL"58 }59 ],60 "emails": [61 {62 "id": "MY385474HPFSC",63 "email": "[email protected]"64 }65 ],66 "registered_business_address": {67 "address_line_1": "Campus 611 - 1876",68 "address_line_2": "West Seattle",69 "admin_area_2": "Seattle",70 "admin_area_1": "WA",71 "postal_code": "98109",72 "country_code": "US"73 },74 "phone_numbers": [75 {76 "country_code": "1",77 "national_number": "06151188",78 "id": "64A97NN4D9PY4",79 "type": "BUSINESS"80 }81 ],82 "identification_documents": [83 {84 "id": "5EFVCDDQ2Z9QL",85 "identification_number": "****",86 "issuing_country_code": "US",87 "type": "EMPLOYER_IDENTIFICATION_NUMBER"88 }89 ],90 "beneficial_owners": {91 "individuals": [92 {93 "id": "U7UT2BWYC3QRQ",94 "names": [95 {96 "given_name": "Another oneaa",97 "surname": "Collins",98 "id": "VALYE8XW8HVTC",99 "type": "LEGAL"100 }101 ],102 "citizenship": "US",103 "addresses": [104 {105 "address_line_1": "Campus 611 - 1876",106 "address_line_2": "West Seattle",107 "admin_area_2": "Seattle",108 "admin_area_1": "WA",109 "postal_code": "98109",110 "country_code": "US",111 "id": "V6T7ETBN6UUMC",112 "type": "HOME"113 }114 ],115 "phone_numbers": [116 {117 "country_code": "1",118 "national_number": "06151188",119 "id": "WYGMHT8WQ8TFQ",120 "type": "WORK"121 }122 ],123 "birth_details": {124 "date_of_birth": "1990-01-01"125 },126 "identification_documents": [127 {128 "id": "WBCR4FS8JDLAA",129 "identification_number": "****",130 "issuing_country_code": "US",131 "type": "SOCIAL_SECURITY_NUMBER"132 }133 ],134 "percentage_of_ownership": "30",135 "controlling_influence": false136 }137 ]138 },139 "office_bearers": [140 {141 "id": "NA95XS3VZV67C",142 "names": [143 {144 "given_name": "Another oneaa",145 "surname": "Collins",146 "id": "EJA8XWJ67NYFC",147 "type": "LEGAL"148 }149 ],150 "citizenship": "US",151 "addresses": [152 {153 "address_line_1": "Campus 611 - 1876",154 "address_line_2": "West Seattle",155 "admin_area_2": "Seattle",156 "admin_area_1": "WA",157 "postal_code": "98109",158 "country_code": "US",159 "id": "HLEHH2UJS4S7G",160 "type": "HOME"161 }162 ],163 "phone_numbers": [164 {165 "country_code": "1",166 "national_number": "06151188",167 "id": "3HKH2AUC97Z32",168 "type": "WORK"169 }170 ],171 "birth_details": {172 "date_of_birth": "1990-01-01"173 },174 "identification_documents": [175 {176 "id": "6JUCSU4PWQ2N6",177 "identification_number": "****",178 "issuing_country_code": "US",179 "type": "SOCIAL_SECURITY_NUMBER"180 }181 ],182 "emails": [183 {184 "email": "[email protected]"185 }186 ]187 }188 ],189 "declarations": [190 {191 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",192 "value": "YES"193 }194 ]195 },196 "agreements": [197 {198 "type": "TERMS_ACCEPTED",199 "accepted_time": "2019-06-02T01:23:45Z"200 }201 ],202 "balances": [203 {204 "available": {205 "currency_code": "USD",206 "value": "0.00"207 },208 "reserved": {209 "currency_code": "USD",210 "value": "0.00"211 }212 }213 ],214 "external_id": "EXT-1695176396",215 "organization": "us_org/net",216 "user_id": "1695176396",217 "primary_currency_code": "USD",218 "soft_descriptor": "DEMO",219 "capabilities": [220 {221 "name": "APPLE_PAY",222 "status": "NEED_DATA"223 },224 {225 "name": "GOOGLE_PAY",226 "status": "NEED_DATA"227 },228 {229 "name": "CUSTOM_CARD_PROCESSING",230 "status": "NEED_DATA"231 },232 {233 "name": "RECEIVE_MONEY",234 "status": "NEED_DATA"235 }236 ],237 "process_view": {238 "processes": [239 {240 "name": "MANAGED_PATH_BO_VERIFICATION",241 "status": "COMPLETED",242 "capabilities": [243 {244 "name": "CUSTOM_CARD_PROCESSING"245 },246 {247 "name": "GOOGLE_PAY"248 },249 {250 "name": "RECEIVE_MONEY"251 },252 {253 "name": "APPLE_PAY"254 }255 ]256 },257 {258 "name": "MANAGED_PATH_KYC_COLLECTION",259 "status": "COMPLETED",260 "capabilities": [261 {262 "name": "APPLE_PAY"263 },264 {265 "name": "CUSTOM_CARD_PROCESSING"266 },267 {268 "name": "RECEIVE_MONEY"269 },270 {271 "name": "GOOGLE_PAY"272 }273 ]274 },275 {276 "name": "MANAGED_PATH_KYC_VERIFICATION",277 "status": "COMPLETED",278 "capabilities": [279 {280 "name": "CUSTOM_CARD_PROCESSING"281 },282 {283 "name": "RECEIVE_MONEY"284 },285 {286 "name": "APPLE_PAY"287 },288 {289 "name": "GOOGLE_PAY"290 }291 ]292 },293 {294 "name": "MANAGED_PATH_BO_COLLECTION",295 "status": "NEED_MORE_DATA",296 "capabilities": [297 {298 "name": "CUSTOM_CARD_PROCESSING"299 },300 {301 "name": "RECEIVE_MONEY"302 },303 {304 "name": "APPLE_PAY"305 },306 {307 "name": "GOOGLE_PAY"308 }309 ],310 "required": {311 "op": "ALL_OF",312 "attributes": [313 "$.business_entity.beneficial_owners.individuals[?(@['id']=='U7UT2BWYC3QRQ')].emails"314 ]315 }316 }317 ]318 },319 "links": [320 {321 "href": "https://te-te-epp-standard-int-test.qa.paypal.com/v3/customer/managed-accounts/96Z6XGVFD75X8",322 "rel": "self",323 "method": "GET"324 },325 {326 "href": "https://te-te-epp-standard-int-test.qa.paypal.com/v3/customer/managed-accounts/96Z6XGVFD75X8",327 "rel": "edit",328 "method": "PATCH"329 }330 ]}
No website provided
The following sample response shows an error if a website isn't provided for an ecommerce business. Any ecommerce merchant without a website can be immediately and potentially permanently suspended or limited in payment processing.
Sample response
- Public Corporation
- Public Corporation Website True
1{2 {"name": "INVALID_REQUEST",3 "message": "Request is not well-formed, syntactically incorrect, or violates schema.",4 "debug_id": "4b6cdc2b8a7fe",5 "details": [6 {7 "field": "/business_entity/website_info",8 "value": "website_info is missing!",9 "issue": "BUSINESS_WEBSITE_INFO_INVALID",10 "description": "Invalid business_entity.website_info."11 }12 ],13 "links": [14 {15 "href": "https://developer.paypal.com/docs/api/managed-accounts",16 "rel": "information_link",17 "method": "GET"18 }19 ]}
No date of birth provided
The following sample response shows an error if you do not provide a date of birth. The merchant won't be able to transact without providing a date of birth.
Sample response
- Public Corporation or Government Agency
- Individual or Sole Proprietorship
- Partnership or Private Corporation or Non Profit
1{2 {"account_id": "KL8937KCQQZDJ",3 "legal_country_code": "US",4 "individual_owners": [5 {6 "id": "KL8937KCQQZDJ",7 "names": [8 {9 "given_name": "Mary",10 "surname": "Collins",11 "id": "LP72BJETCDUZA",12 "type": "LEGAL"13 }14 ],15 "citizenship": "US",16 "primary_residence": {17 "address_line_1": "1234 Lane1 Drive",18 "admin_area_2": "100",19 "postal_code": "95014",20 "country_code": "US"21 },22 "phone_numbers": [23 {24 "country_code": "030",25 "national_number": "6151175",26 "id": "APH4JRDJD3ESQ",27 "type": "MOBILE"28 }29 ],30 "identification_documents": [31 {32 "id": "2LB8L79W7VW94",33 "identification_number": "****",34 "issuing_country_code": "US",35 "type": "SOCIAL_SECURITY_NUMBER"36 }37 ],38 "emails": [39 {40 "id": "8QBGTYRRPTY3W",41 "email": "[email protected]"42 }43 ]44 }45 ],46 "business_entity": {47 "type": "PUBLIC_COMPANY",48 "merchant_category_code": "5933",49 "incorporation_details": {},50 "names": [51 {52 "business_name": "Demo",53 "id": "FGMKYATPU2ECQ",54 "type": "LEGAL"55 }56 ],57 "emails": [58 {59 "id": "3U853U4ZZR2VA",60 "email": "[email protected]"61 }62 ],63 "website_info": {64 "website_exists": true,65 "website_url": "www.test.com"66 },67 "registered_business_address": {68 "address_line_1": "Vancouver Campus 611 - 1876",69 "address_line_2": "West Mall",70 "admin_area_2": "Vancouver ",71 "admin_area_1": "BC",72 "postal_code": "V6T 1Z2",73 "country_code": "CA"74 },75 "phone_numbers": [76 {77 "country_code": "1",78 "national_number": "06151188",79 "id": "XGK4ZZSN6X54Q",80 "type": "BUSINESS"81 }82 ],83 "identification_documents": [84 {85 "id": "D96JT9XQ5KPN2",86 "identification_number": "****",87 "issuing_country_code": "US",88 "type": "EMPLOYER_IDENTIFICATION_NUMBER"89 }90 ],91 "declarations": [92 {93 "name": "TWENTY_FIVE_PERCENT_BENEFICIAL_OWNER",94 "value": "NO"95 }96 ]97 },98 "agreements": [99 {100 "type": "TERMS_ACCEPTED",101 "accepted_time": "2019-06-02T01:23:45Z"102 }103 ],104 "external_id": "EXT11-1694420173",105 "organization": "us",106 "user_id": "1694420173",107 "primary_currency_code": "USD",108 "soft_descriptor": "DEMO",109 "capabilities": [110 {111 "name": "APPLE_PAY",112 "status": "NEED_DATA"113 },114 {115 "name": "GOOGLE_PAY",116 "status": "NEED_DATA"117 },118 {119 "name": "CUSTOM_CARD_PROCESSING",120 "status": "NEED_DATA"121 },122 {123 "name": "RECEIVE_MONEY",124 "status": "NEED_DATA"125 },126 {127 "name": "WITHDRAW_MONEY",128 "status": "NEED_DATA"129 }130 ],131 "process_view": {132 "processes": [133 {134 "name": "MANAGED_PATH_BO_COLLECTION",135 "status": "COMPLETED",136 "capabilities": [137 {138 "name": "APPLE_PAY"139 },140 {141 "name": "CUSTOM_CARD_PROCESSING"142 },143 {144 "name": "GOOGLE_PAY"145 },146 {147 "name": "WITHDRAW_MONEY"148 },149 {150 "name": "RECEIVE_MONEY"151 }152 ]153 },154 {155 "name": "MANAGED_PATH_KYC_VERIFICATION",156 "status": "COMPLETED",157 "capabilities": [158 {159 "name": "RECEIVE_MONEY"160 },161 {162 "name": "CUSTOM_CARD_PROCESSING"163 },164 {165 "name": "WITHDRAW_MONEY"166 },167 {168 "name": "GOOGLE_PAY"169 },170 {171 "name": "APPLE_PAY"172 }173 ]174 },175 {176 "name": "MANAGED_PATH_BO_VERIFICATION",177 "status": "COMPLETED",178 "capabilities": [179 {180 "name": "CUSTOM_CARD_PROCESSING"181 },182 {183 "name": "APPLE_PAY"184 },185 {186 "name": "RECEIVE_MONEY"187 },188 {189 "name": "GOOGLE_PAY"190 },191 {192 "name": "WITHDRAW_MONEY"193 }194 ]195 },196 {197 "name": "MANAGED_PATH_KYC_COLLECTION",198 "status": "NEED_MORE_DATA",199 "capabilities": [200 {201 "name": "RECEIVE_MONEY"202 },203 {204 "name": "APPLE_PAY"205 },206 {207 "name": "WITHDRAW_MONEY"208 },209 {210 "name": "GOOGLE_PAY"211 },212 {213 "name": "CUSTOM_CARD_PROCESSING"214 }215 ],216 "required": {217 "op": "ALL_OF",218 "attributes": [219 "$.individual_owners[?(@['id']=='KL8937KCQQZDJ')].birth_details.date_of_birth"220 ]221 }222 }223 ]224 },225 "links": [226 {227 "href": "https://te-te-epp-standard-int-test.qa.paypal.com/v3/customer/managed-accounts/KL8937KCQQZDJ",228 "rel": "self",229 "method": "GET"230 },231 {232 "href": "https://te-te-epp-standard-int-test.qa.paypal.com/v3/customer/managed-accounts/KL8937KCQQZDJ",233 "rel": "edit",234 "method": "PATCH"235 }236 ]}